Skip to content

Commit 714d02b

Browse files
committed
Add seeding docs
1 parent 195257f commit 714d02b

File tree

4 files changed

+54
-7
lines changed

4 files changed

+54
-7
lines changed

README.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A CLI for the hyper:// space network ([Hypercore Protocol](https://hypercore-pro
99
- [Sharing a folder](./docs/guides/sharing-a-folder.md)
1010
- [Downloading a folder](./docs/guides/downloading-a-folder.md)
1111
- [Keeping hypers online (seeding)](./docs/guides/seeding.md)
12+
- [List your current seeds](./docs/guide/list-seeds.md)
1213
- [Creating a hyperdrive](./docs/guides/creating-a-hyperdrive.md)
1314
- [Reading a file from a hyperdrive](./docs/guides/reading-a-file.md)
1415
- [Writing a file to a hyperdrive](./docs/guides/writing-a-file.md)
@@ -30,8 +31,9 @@ Usage: hyp <command> [opts...]
3031

3132
General Commands:
3233

33-
hyp info {urls...} - Show information about one (or more) hypers.
34-
hyp host {urls...} - Sync and host hyper data.
34+
hyp info [urls...] - Show information about one (or more) hypers.
35+
hyp seed {urls...} - Download and make hyper data available to the network.
36+
hyp unseed {urls...} - Stop making hyper data available to the network.
3537
hyp create {drive|bee} - Create a new hyperdrive or hyperbee.
3638

3739
Hyperdrive Commands:
@@ -59,7 +61,7 @@ Hyperbee Commands:
5961
Daemon Commands:
6062

6163
hyp daemon status - Check the status of the hyperspace daemon.
62-
hyp daemon stop - Stop the hyperspace daemon if active.
64+
hyp daemon stop - Stop the hyperspace and mirroring daemons if active.
6365

6466
Aliases:
6567

@@ -99,17 +101,24 @@ You can create a new hyperdrive or hyperbee using the `create` commands:
99101
hyp create drive
100102
```
101103
102-
You can then host the hyper (or host a hyper created by somebody else) using the `host` command:
104+
You can then seed the hyper (or seed a hyper created by somebody else) using the `seed` command:
103105
104106
```
105-
hyp host hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
107+
hyp seed hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/
108+
```
109+
110+
To see what hypers you are currently seeding, run `info`:
111+
112+
```
113+
hyp info
106114
```
107115
108116
Further guides:
109117
110118
- [Sharing a folder](./docs/guides/sharing-a-folder.md)
111119
- [Downloading a folder](./docs/guides/downloading-a-folder.md)
112120
- [Keeping hypers online (seeding)](./docs/guides/seeding.md)
121+
- [List your current seeds](./docs/guide/list-seeds.md)
113122
- [Reading a file from a hyperdrive](./docs/guides/reading-a-file.md)
114123
- [Writing a file to a hyperdrive](./docs/guides/writing-a-file.md)
115124
- [Diffing hyperdrives and local folders](./docs/guides/diffing-a-hyperdrive.md)

docs/glossary.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ A collection of terms used in `hyp` and the [Hypercore Protocol](https://hyperco
1010
- **Hyperspace**. Two meanings:
1111
- A general term for the ecosystem and network of the Hypercore Protocol.
1212
- The name of the daemon program behind `hyp`. [See the docs](https://github.com/hypercore-protocol/hyperspace).
13-
- **Key**. The 64-character hex string that identifies hypers. The key is shared in hyper structure URLs with the `hyper://` scheme.
13+
- **Key**. The 64-character hex string that identifies hypers. The key is shared in hyper structure URLs with the `hyper://` scheme.
14+
- **Seeding**. Actively syncing the current data of a hyper-structure and hosting its data from your device for others to access.

docs/guides/list-seeds.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# List your current seeds
2+
3+
```
4+
hyp info [urls..]
5+
```
6+
7+
The info command will tell you what you are currently seeding if given no arguments:
8+
9+
```
10+
hyp info
11+
```
12+
13+
If one (or more) URLs are supplied, it will give the current seeding state of that hyper:
14+
15+
```
16+
hyp info hyper://1234..af
17+
```

docs/guides/seeding.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# Keeping hypers online (seeding)
22

3-
TODO
3+
```
4+
hyp seed {url}
5+
```
6+
7+
To sync the current data of a hyper and host its data for others to access, run the seed command on its URL:
8+
9+
```
10+
hyp seed hyper://1234..af
11+
```
12+
13+
You can stop seeding with the unseed command:
14+
15+
```
16+
hyp unseed hyper://1234..af
17+
```
18+
19+
You can list all currently-seeded hypers with the info command:
20+
21+
```
22+
hyp info
23+
```

0 commit comments

Comments
 (0)