Skip to content

This is the repository for the appear.in developer SDK JavaScript source. It's available on npm and as a standalone (pending). The files in this repository are used for building the standalone, as well as contain the sources for the npm package.

License

Notifications You must be signed in to change notification settings

aimfuture/appearin-sdk

 
 

Repository files navigation

appear.in JavaScript SDK

The official appear.in JavaScript SDK, available for browsers.

Release notes can be found at https://developer.appear.in/#sdk-changelog

Build Status

NPM NPM

Installing

You can add this library to your browserify/whatever is cool these days package by doing:

npm install appearin-sdk

Alternatively, you can fetch link to the sources directly at the bottom of you body:

<script src="//developer.appear.in/scripts/appearin-sdk.0.0.4.min.js"></script>

You can read more on the appear.in API at our developer pages.

Documentation can be found at our developer pages too.

Development

This section is only here for those manually going to the GitHub repository and want to build/hack it themselves.

The project uses browserify to compile the sources. A test page has been added as index.html to verify that the core functionality is working. Hopefully this will be replaced by automated tests soon™.

To start off, run npm install to fetch dependencies.

To compile the latest sources do grunt dev.

Building outside NPM

Building outside NPM is done by doing grunt build. This will create three files:

appearin-sdk.<version>.js
appearin-sdk.<version>.min.js
appearin-sdk.<version>.min.js.map

These can be self hosted, and they contain all dependencies necessary, including wrapping with browserify-standalone.

About

This is the repository for the appear.in developer SDK JavaScript source. It's available on npm and as a standalone (pending). The files in this repository are used for building the standalone, as well as contain the sources for the npm package.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.6%
  • HTML 5.4%