Permalink
Browse files

[docs] Add usage section to README

  • Loading branch information...
1 parent 955f362 commit 3166153a44d0827cacf2ef3115d6e910e357a344 @mmalecki committed Oct 30, 2011
Showing with 10 additions and 0 deletions.
  1. +10 −0 README.md
View
@@ -4,6 +4,16 @@ MIT License (see LICENSE file)
Mount your device from node.js like what.
+## Usage
+
+```javascript
+var mount = require('mount');
+mount.mount('tmpfs', 'tmpDir', 'tmpfs');
+// ... do some stuff in tmpDir
+mount.unmount('tmpDir');
+// BAH! everything from tmpDir is gone!
+```
+
## Installation
npm install mount

0 comments on commit 3166153

Please sign in to comment.