Updated README with current installation methods

We added compatibility for new and exciting ways of including Filer in user's projects. Now they can read how!
This commit is contained in:
Kieran Sedgwick 2014-05-29 12:36:00 -04:00
parent d0418fa0d3
commit 4abdfb0bd0
1 changed files with 29 additions and 11 deletions

View File

@ -25,12 +25,30 @@ See the section on [Storage Providers](#providers).
Want to join the fun? We'd love to have you! See [CONTRIBUTING](https://github.com/js-platform/filer/blob/develop/CONTRIBUTING.md).
###Downloading
###Downloading & Installation
Pre-built versions of the library are available in the repo:
Though pre-built versions of the library are available [in the repo](https://github.com/js-platform/filer/tree/develop/dist), Filer is available for download through the most popular Node.js and browser package managers: [Bower](http://bower.io/) & [NPM](https://www.npmjs.org/).
* [filer.js](https://raw.github.com/js-platform/filer/develop/dist/filer.js)
* [filer.min.js](https://raw.github.com/js-platform/filer/develop/dist/filer.min.js)
#### Node.js
Install the latest stable version of Filer for use in Node.js projects by running:
* `npm install filer` or `npm install filer --save` to automatically save the dependency to your `package.json` file.
##### Usage
Instantiation is as easy as `var filer = require('filer');`
#### The Browser
Install the latest stable version of Filer for use in the browser with Bower like so:
* `bower install filer`
##### Usage
Filer can be loaded from `bower_modules/filer/dist/filer.js` or `.../filer.min.js`:
1. As a regular script, which then attaches `Filer` to the global `window` object
2. As a UMD module, for use with a system like RequireJS
### Getting Started