Browse Source

update readme

ameba23 3 years ago
parent
commit
dc1f61e555
1 changed files with 6 additions and 5 deletions
  1. 6
    5
      README.md

+ 6
- 5
README.md View File

@@ -4,15 +4,16 @@ mount a `kappa-drive` with `hyperdrive-fuse`.
4 4
 
5 5
 ## API
6 6
 ```
7
-const mount = require('kappa-drive-mount')
7
+const MountDrive = require('kappa-drive-mount')
8
+const mountDrive = MountDrive() 
8 9
 ```
9 10
 
10
-### `const destroy = mount(drive, destination)`
11
+### `const destroy = mountDrive.mount(drive, destination, options)`
11 12
 
12
-mount a kappa-drive, `drive` at path `destination`.
13
+mount a kappa-drive, `drive` at path `destination`. `options` will be passed to `hyperdrive-fuse`
13 14
 
14
-Returns a promise which passes a destroy function
15
+Returns a promise which passes a destroy function.
15 16
 
16
-### `const cleanedUp = destroy.then((destroy) => { mount.cleanup(destroy, desination)})`  
17
+### `const cleanedUp = destroy.then((destroy) => { mountDrive.cleanup(destroy, desination)})`  
17 18
 
18 19
 unmount and remove the mounted drive.  Returns a promise