LumeWeb
/
filer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
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). 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) #### Node.js
* [filer.min.js](https://raw.github.com/js-platform/filer/develop/dist/filer.min.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 ### Getting Started
@ -461,8 +479,8 @@ fs.link("/data/logs/august", "/data/logs/current", function(err) {
#### fs.exists(path, callback)<a name="exists"></a> #### fs.exists(path, callback)<a name="exists"></a>
Test whether or not the given path exists by checking with the file system. Test whether or not the given path exists by checking with the file system.
Then call the callback argument with either true or false. Then call the callback argument with either true or false.
Example: Example:
@ -559,7 +577,7 @@ Example:
fs.mknod('/dir', 'DIRECTORY', function(err) { fs.mknod('/dir', 'DIRECTORY', function(err) {
if(err) throw err; if(err) throw err;
// /dir is now created // /dir is now created
// Create a file inside /dir // Create a file inside /dir
fs.mknod('/dir/myfile', 'FILE', function(err) { fs.mknod('/dir/myfile', 'FILE', function(err) {
if(err) throw err; if(err) throw err;
@ -844,7 +862,7 @@ Examples:
```javascript ```javascript
// Append UTF8 text file // Append UTF8 text file
fs.writeFile('/myfile.txt', "More...", function (err) { fs.writeFile('/myfile.txt', "More...", function (err) {
if (err) throw err; if (err) throw err;
}); });
fs.appendFile('/myfile.txt', "Data...", function (err) { fs.appendFile('/myfile.txt', "Data...", function (err) {
if (err) throw err; if (err) throw err;
@ -855,7 +873,7 @@ fs.appendFile('/myfile.txt', "Data...", function (err) {
var more = new Uint8Array([1, 2, 3, 4]); var more = new Uint8Array([1, 2, 3, 4]);
var data = new Uint8Array([5, 6, 7, 8]); var data = new Uint8Array([5, 6, 7, 8]);
fs.writeFile('/myfile', more, function (err) { fs.writeFile('/myfile', more, function (err) {
if (err) throw err; if (err) throw err;
}); });
fs.appendFile('/myfile', buffer, function (err) { fs.appendFile('/myfile', buffer, function (err) {
if (err) throw err; if (err) throw err;
@ -1323,9 +1341,9 @@ sh.tempDir(function(err, tmp) {
#### sh.mkdirp(path, callback)<a name="mkdirp"></a> #### sh.mkdirp(path, callback)<a name="mkdirp"></a>
Recursively creates the directory at the provided path. If the Recursively creates the directory at the provided path. If the
directory already exists, no error is returned. All parents must directory already exists, no error is returned. All parents must
be valid directories (not files). be valid directories (not files).
Example: Example: