diff options
author | Joe Hand <joe@joeahand.com> | 2016-08-05 08:47:15 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-08-05 08:47:15 -0700 |
commit | ffb465bb3bcebb62c5e63cc3ed80d70274848deb (patch) | |
tree | 68203eafcf5b422464dbd4ebf53742e487735ad9 /docs/api.md | |
parent | 2b6ddccb62e7c425ed2a88b8cd9f94322d31aaaa (diff) | |
download | dat-docs-ffb465bb3bcebb62c5e63cc3ed80d70274848deb.tar.gz dat-docs-ffb465bb3bcebb62c5e63cc3ed80d70274848deb.zip |
Use ecosystem docs to add module readme docs (#12)
* organize for ecosystem docs and cleanup
Signed-off-by: Joe Hand <joe@joeahand.com>
* add ecosystem-docs commands, build file, docs
* remove transform & fix content typo
* upgrade minidocs
Diffstat (limited to 'docs/api.md')
-rw-r--r-- | docs/api.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..68a7c3f --- /dev/null +++ b/docs/api.md @@ -0,0 +1,29 @@ +## 1.0 Architecture Design + + + * dat: command-line api + * dat-desk: desktop application + * hyperdrive: storage layer + * discovery-swarm: dat network swarm discovery mechanism + +## dat + +Command-line interface for dat + +#### `dat share DIR` + +Create a new dat link for the contents of the given directory. Prints a URL, which is a unique public key feed. This public key feed can be appended to. + +###### Options + + * `--append=URL`: Adds the new URL to the public key feed. + * `--static`: Ensures that the URL cannot be appended to. + +#### `dat URL DIR` + +Downloads the link to the given directory, and then exits. + +###### Options + + * `--seed`: Downloads the link to the given directory and opens up a server that seeds it to the dat peer network. + * `--list`: Fetches the metadata for the link and prints out the file list in the console. |