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 * See [remotestorage.io](http://remotestorage.io/) for documentation, community forums, and links.
   8
   9 ### Running a local test server
  10
  11 To test remoteStorage-enabled apps, you need to have a remoteStorage-compatible storage account.
  12
  13 To find out how to get one, see [Get Storage on remotestorage.io](http://remotestorage.io/get/).
  14
  15 ### Which version to choose?
  16
  17 You can either use a stable release or the current HEAD build. Stable releases
  18 can be found in [release/](https://github.com/remotestorage/remotestorage.js/tree/master/release/).
  19 Those directories having a "-rcX" suffix contain release candidates, which may
  20 be used for testing but aren't necessarily "stable" releases.
  21
  22 The toplevel directory contains a semi-current HEAD build. It is updated
  23 manually and irregularly. To build an up-to-date version of all files, run
  24 `make all` in the repository root.
  25
  26 ### Which build file to use for my app?
  27
  28 There are a number of different builds available:
  29
  30 * <kbd>remotestorage.js</kbd> - Contains all components of remotestorage.js for running in a browser.
  31 * <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/).
  32 * <kbd>remotestorage.min.js</kbd> - Minified version of remotestorage.js
  33 * <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).
  34 * <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.
  35
  36 ### How to build
  37
  38 Run `make` to display the available build tasks.
  39
  40 With node-uglify and naturaldocs installed, you can run `make all` to build everything.