Update docs to point to new website

pfrazee · pfrazee · commit 3197b9e6e095 · 2020-12-24T10:09:37.000-06:00
diff --git a/README.md b/README.md
@@ -2,23 +2,17 @@
 
 # Hyp
 
+<p>[
+  <a href="https://www.youtube.com/watch?v=SVk1uIQxOO8">Demo Video</a>
+  <a href="#installation">Installation</a> |
+  <a href="#usage">Usage</a> |
+  <a href="#overview">Overview</a> |
+  <a href="https://hypercore-protocol.org/guides/hyp/">Documentation</a>
+]</p>
+
 A CLI for peer-to-peer file sharing (and more) using the [Hypercore Protocol](https://hypercore-protocol.org).
 
-- [Installation](#installation)
-- [Usage](#usage)
-- [Overview](#overview)
-- Guides
-  - [Sharing a folder](./docs/guides/sharing-a-folder.md)
-  - [Downloading a folder](./docs/guides/downloading-a-folder.md)
-  - [Keeping hypers online (seeding)](./docs/guides/seeding.md)
-  - [List your current seeds](./docs/guides/list-seeds.md)
-  - ["Beaming" data](./docs/guides/beaming-data.md)
-  - [Creating a hyperdrive](./docs/guides/creating-a-hyperdrive.md)
-  - [Reading a file from a hyperdrive](./docs/guides/reading-a-file.md)
-  - [Writing a file to a hyperdrive](./docs/guides/writing-a-file.md)
-  - [Diffing hyperdrives and local folders](./docs/guides/diffing-a-hyperdrive.md)
-- [Glossary of terms](./docs/glossary.md)
-- [API Docs](https://github.com/hypercore-protocol/hyperspace-client)
+[📺 Watch a Demo](https://www.youtube.com/watch?v=SVk1uIQxOO8)
 
 ## Installation
 
@@ -121,25 +115,11 @@ To see what hypers you are currently seeding, run `info`:
 hyp info
 ```
 
-If you're sharing with a single friend or one of your own devices, you can [beam the URL](./docs/guides/beaming-data.md) with a pass phrase you create. One your sending device:
-
-```
-echo "hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/" | hyp beam
-```
-
-This will generate a pass-phrase which you can enter on the receiving device to get the key:
-
-```
-hyp beam "the generated phrase"
-```
+## [Documentation](https://hypercore-protocol.org/guides/hyp/)
 
-Further guides:
+The [official docs](https://hypercore-protocol.org/guides/hyp/) have a lot of useful guides:
 
-- [Sharing a folder](./docs/guides/sharing-a-folder.md)
-- [Downloading a folder](./docs/guides/downloading-a-folder.md)
-- [Keeping hypers online (seeding)](./docs/guides/seeding.md)
-- [List your current seeds](./docs/guides/list-seeds.md)
-- ["Beaming" data](./docs/guides/beaming-data.md)
-- [Reading a file from a hyperdrive](./docs/guides/reading-a-file.md)
-- [Writing a file to a hyperdrive](./docs/guides/writing-a-file.md)
-- [Diffing hyperdrives and local folders](./docs/guides/diffing-a-hyperdrive.md)
+- [Full Commands Reference](https://hypercore-protocol.org/guides/hyp/commands/)
+- [Guide: Sharing Folders](https://hypercore-protocol.org/guides/hyp/sharing-folders/)
+- [Guide: Seeding Data](https://hypercore-protocol.org/guides/hyp/seeding-data/)
+- [Guide: Beaming Files](https://hypercore-protocol.org/guides/hyp/beaming-files/)
diff --git a/docs/guides/beaming-data.md b/docs/guides/beaming-data.md
@@ -1,23 +1,5 @@
 # Beaming data
 
-```
-hyp beam [passphrase]
-```
+This doc was moved to the website:
 
-Ever wish you had a fast way to send files or data to a device? For instance...
-
- - Send a `hyper://` URL to another device for syncing
- - Copy an individual file to a friend's device
- - Run a command and share the output with a team-mate to debug
-
-That's what the "beam" command is for. It acts like a stream, so you can pipe data in and out of the command.
-
-```
-cat my-file.txt | hyp beam
-```
-
-It will generate a passphrase for you, like "manager car factory". You use that phrase on the receiving device and pipe out the data:
-
-```
-hyp beam "manager car factory" > ./their-file.txt
-```
+https://hypercore-protocol.org/guides/hyp/beaming-files/
diff --git a/docs/guides/creating-a-hyperdrive.md b/docs/guides/creating-a-hyperdrive.md
@@ -1,9 +1,5 @@
 # Creating a hyperdrive
 
-```
-hyp create drive
-```
+This doc was moved to the website:
 
-This will output the URL of your new hyperdrive and you'll be ready to go.
-
-> If you're just looking to share a folder, you can [use the sync command](./sharing-a-folder.md).
+https://hypercore-protocol.org/guides/hyp/commands/create/
diff --git a/docs/guides/diffing-a-hyperdrive.md b/docs/guides/diffing-a-hyperdrive.md
@@ -1,18 +1,5 @@
 # Diffing hyperdrives and local folders
 
-```
-hyp diff {source} {target}
-```
+This doc was moved to the website:
 
- - **source** A local folder path or hyperdrive URL.
- - **target** A local folder path or hyperdrive URL.
-
-The command will output a list of all files that differ and explain how they differ.
-
-You can sync the target so that it matches the source by adding the `--commit` switch:
-
-```
-hyp diff {source} {target} --commit
-```
-
-This will give you a chance to review the changes about to occur, then y/n the sync.
+https://hypercore-protocol.org/guides/hyp/commands/drive-diff/
diff --git a/docs/guides/downloading-a-folder.md b/docs/guides/downloading-a-folder.md
@@ -1,18 +1,5 @@
 # Downloading a folder from a hyperdrive
 
-```
-hyp sync {source} [target]
-```
+This doc was moved to the website:
 
-- **source** The hyperdrive you want to download.
-- **target** The path of the local folder you want to download to.
-
-Example:
-
-```
-hyp sync hyper://1234..af ./target-folder
-```
-
-You can re-run the command to update the target folder. It will cause the target folder to match the hyperdrive *exactly* so watch out for data loss.
-
-> If you include `--watch` the sync command will continuously sync the source to the target.
+https://hypercore-protocol.org/guides/hyp/sharing-folders/
diff --git a/docs/guides/list-seeds.md b/docs/guides/list-seeds.md
@@ -1,17 +1,5 @@
 # List your current seeds
 
-```
-hyp info [urls..]
-```
+This doc was moved to the website:
 
-The info command will tell you what you are currently seeding if given no arguments:
-
-```
-hyp info
-```
-
-If one (or more) URLs are supplied, it will give the current seeding state of that hyper:
-
-```
-hyp info hyper://1234..af
-```
+https://hypercore-protocol.org/guides/hyp/seeding-data/
diff --git a/docs/guides/reading-a-file.md b/docs/guides/reading-a-file.md
@@ -1,17 +1,5 @@
 # Reading a file from a hyperdrive
 
-```
-hyp cat {url}
-```
+This doc was moved to the website:
 
-To read the file, simply run `cat` on the file's URL:
-
-```
-hyp cat hyper://1234..af/hello.txt
-```
-
-You can save the file using pipes:
-
-```
-hyp cat hyper://1234..af/hello.txt > ./hello.txt
-```
+https://hypercore-protocol.org/guides/hyp/commands/drive-cat/
diff --git a/docs/guides/seeding.md b/docs/guides/seeding.md
@@ -1,23 +1,5 @@
 # Keeping hypers online (seeding)
 
-```
-hyp seed {url}
-```
+This doc was moved to the website:
 
-To sync the current data of a hyper and host its data for others to access, run the seed command on its URL:
-
-```
-hyp seed hyper://1234..af
-```
-
-You can stop seeding with the unseed command:
-
-```
-hyp unseed hyper://1234..af
-```
-
-You can list all currently-seeded hypers with the info command:
-
-```
-hyp info
-```
+https://hypercore-protocol.org/guides/hyp/seeding-data/
diff --git a/docs/guides/sharing-a-folder.md b/docs/guides/sharing-a-folder.md
@@ -1,26 +1,5 @@
 # Sharing a folder in a hyperdrive
 
-```
-hyp sync {source} [target]
-```
+This doc was moved to the website:
 
-- **source** The path of the folder to share.
-- **target** Optional- the hyperdrive to sync the folder to.
-
-If no target is supplied, `hyp` will create a new hyperdrive for you. 
-
-```
-hyp sync ./target-folder
-```
-
-The sync command will output the URL of your new hyperdrive, and it will now contain your folder's files.
-
-To update the hyperdrive again, run:
-
-```
-hyp sync ./target-folder hyper://1234..af
-```
-
-Where `hyper://1234..af` is your hyperdrive's URL.
-
-> If you include `--watch` the sync command will continuously sync the source to the target.
+https://hypercore-protocol.org/guides/hyp/sharing-folders/
diff --git a/docs/guides/writing-a-file.md b/docs/guides/writing-a-file.md
@@ -1,19 +1,5 @@
 # Writing an individual file to hyperdrive
 
-```
-hyp put {url} [value]
-```
+This doc was moved to the website:
 
-You'll first need to [create a hyperdrive](./creating-a-hyperdrive.md).
-
-To write a file, run the `put` command on the URL and provide the content of the file:
-
-```
-hyp put hyper://1234..af/hello.txt "Hello, world!"
-```
-
-If you want to copy an existing file into the hyperdrive, use pipes instead of supplying the value in the arguments:
-
-```
-cat hello.txt | hyp put hyper://1234..af/hello.txt
-```
+https://hypercore-protocol.org/guides/hyp/commands/drive-put/
