10.0.0.21 Git - remotestorage.js/blob - README.md

   1 # remoteStorage.js
   2
   3 [![Build Status](https://secure.travis-ci.org/remotestorage/remotestorage.js.png)](http://travis-ci.org/remotestorage/remotestorage.js)
   4
   5 ### Where to get help?
   6
   7 * Consult this README
   8 * Read the Guides:
   9   * [Adding remoteStorage to your app](http://remotestorage.io/integrate/add-to-app.html)
  10   * [Howto contribute](http://remotestoragejs.com/doc/code/files2/howto-contribute-txt.html)
  11   * [Working with schemas](http://remotestoragejs.com/doc/code/files2/howto-include-txt.html)
  12   * [How to configure synchronization](http://remotestoragejs.com/doc/code/files/lib/sync-js.html#How_to_configure_sync)
  13 * Consult the [API documentation](http://remotestoragejs.com/doc/code)
  14 * Ask on the [forums](http://community.remotestorage.io/categories)
  15 * Ask in the [IRC Channel](http://webchat.freenode.net/?channels=remotestorage) (#remotestorage on freenode)
  16 * Open an issue in the relevant repository
  17
  18 ### Running a local Test Server
  19
  20 To test remoteStorage enabled apps, you need to have a remoteStorage compatible storage account.
  21
  22 To find out how to get one, see [Get Storage on remotestorage.io](http://remotestorage.io/get/).
  23
  24 ### Which version to choose?
  25
  26 You can either use a stable release or the current HEAD build. Stable releases can be found in [release/](https://github.com/remotestorage/remotestorage.js/tree/master/release/). Those directories having a "-rcX" postfix contain release candidates, which may be used for testing but aren't necessarily "stable" releases.
  27
  28 The toplevel directory contains a semi-current HEAD build. It is updated manually and irregularly. To build an up-to-date version of all files, run `make all` in the repository root.
  29
  30 ### Which build file to use for my app?
  31
  32 There are a number of different builds available:
  33
  34 * <kbd>remotestorage.js</kbd> - Contains all components of remotestorage.js for running in a browser.
  35 * <kbd>remotestorage.amd.js</kbd> - The same as remotestorage.js, but wrapped for use with [AMD](https://en.wikipedia.org/wiki/Asynchronous_module_definition) loaders such as [RequireJS](http://requirejs.org/).
  36 * <kbd>remotestorage.min.js</kbd> - Minified version of remotestorage.js
  37 * <kbd>remotestorage-nocache.js</kbd> - Contains a version of remotestorage.js without any caching features included. Use this if you want your app to write directly to the remote server **without caching** any data in the browser's storage (localStorage or indexedDB).
  38 * <kbd>remotestorage-nocache.amd.js</kbd>, <kbd>remotestorage-nocache.min.js</kbd> - same as the other .amd / .min build, but based on remotestorage-nocache.js.
  39
  40 ### Contributors
  41
  42 To build everything after you made a change to the source, run `make all` and copy the docs to the `gh-pages` branch of https://github.com/remotestorage/remotestorage.io