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

Update README.md

This commit is contained in:
Alan K 2013-11-29 21:28:35 -05:00
parent 43800f48ff
commit 317fa75a84
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,6 +1,6 @@
###IDBFS ###Filer
IDBFS is a POSIX-like file system interface for browser-based JavaScript. Filer is a POSIX-like file system interface for browser-based JavaScript.
The API is as close to the node.js [fs module](http://nodejs.org/api/fs.html) as possible The API is as close to the node.js [fs module](http://nodejs.org/api/fs.html) as possible
with the following differences: with the following differences:
* No synchronous versions of methods (e.g., `mkdir()` but not `mkdirSync()`). * No synchronous versions of methods (e.g., `mkdir()` but not `mkdirSync()`).
@ -10,7 +10,7 @@ with the following differences:
### Contributing ### Contributing
The best way to get started is to read through the `Getting Started` and `Example` sections before having a look through the open [issues](https://github.com/js-platform/idbfs/issues). Some of the issues are marked as `good first bug`, but feel free to contribute to any of the issues there, or open a new one if the thing you want to work on isn't there yet. If you would like to have an issue assigned to you, please send me a message and I'll update it. The best way to get started is to read through the `Getting Started` and `Example` sections before having a look through the open [issues](https://github.com/js-platform/filer/issues). Some of the issues are marked as `good first bug`, but feel free to contribute to any of the issues there, or open a new one if the thing you want to work on isn't there yet. If you would like to have an issue assigned to you, please send me a message and I'll update it.
The build system is based on [grunt](http://gruntjs.com/). To get a working build system The build system is based on [grunt](http://gruntjs.com/). To get a working build system
do the following: do the following:
@ -35,8 +35,8 @@ You can run the tests from the project by opening the `tests` directory in your
Pre-built versions of the library are available in the repo: Pre-built versions of the library are available in the repo:
* [idbfs.js](https://raw.github.com/js-platform/idbfs/develop/dist/idbfs.js) * [idbfs.js](https://raw.github.com/js-platform/filer/develop/dist/idbfs.js)
* [idbfs.min.js](https://raw.github.com/js-platform/idbfs/develop/dist/idbfs.min.js) * [idbfs.min.js](https://raw.github.com/js-platform/filer/develop/dist/idbfs.min.js)
### Getting Started ### Getting Started