From ffb465bb3bcebb62c5e63cc3ed80d70274848deb Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Fri, 5 Aug 2016 08:47:15 -0700 Subject: Use ecosystem docs to add module readme docs (#12) * organize for ecosystem docs and cleanup Signed-off-by: Joe Hand * add ecosystem-docs commands, build file, docs * remove transform & fix content typo * upgrade minidocs --- api.md | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 api.md (limited to 'api.md') diff --git a/api.md b/api.md deleted file mode 100644 index 68a7c3f..0000000 --- a/api.md +++ /dev/null @@ -1,29 +0,0 @@ -## 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. -- cgit v1.2.3