Skip to content

Commit 9438c18

Browse files
authored
Update README.md
1 parent 039ff9c commit 9438c18

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
11
# ⏏️ hypermount
2-
A FUSE-mountable distributed filesystem, built on Hyperdrive
2+
A FUSE-mountable distributed filesystem, built with Hyperdrive.
3+
4+
Hypermount lets your mount Hyperdrives as directories on both OSX and Linux. To create a new mounted Hyperdrive, just run `hypermount mount <an empty dir>` -- hypermount will generate and seed a new Hyperdrive for you, mounted at the specified directory, and it will give you a key you can share with others. To mount someone else's Hyperdrive, just run `hypermount mount <an empty dir> <key>`!
5+
6+
To make it easier to mount multiple drives, Hypermount runs as a daemonized HTTP server. It maintains a database of mounted Hyperdrives, which it will automatically remount when the daemon is started and unmount when it's stopped.
7+
8+
Under the hood, this module uses [corestore](https://github.com/andrewosh/corestore) to manage and seed your library of hypercores.
9+
10+
## Installation
11+
```
12+
npm i hypermount -g
13+
```
14+
15+
### Setup
16+
17+
When you first install Hypermount, you'll need to perform a setup step that will install native, prebuilt FUSE bindings. We currently only provide bindings for OSX and Linux. The setup step is the only step that requires `sudo`.
18+
```
19+
❯ hypermount setup
20+
Configuring FUSE...
21+
[sudo] password for andrewosh:
22+
Successfully configured FUSE!
23+
```
24+
25+
You should only need to perform this step once (it will persist across restarts).
26+
27+
## Usage
28+
29+
Hypermount provides an HTTP interface for mounting, unmounting, and providing status information about all current mounts. There's also a bundled CLI tool
30+
31+
## License
32+
33+
MIT

0 commit comments

Comments
 (0)