diff options
| author | Karissa McKelvey <karissa@users.noreply.github.com> | 2016-08-29 21:14:32 +0200 |
|---|---|---|
| committer | Joe Hand <joe@joeahand.com> | 2016-08-29 12:14:32 -0700 |
| commit | 17926b349a0ab5a761b0a97dde27f71a1e1f332e (patch) | |
| tree | ada2db81418b04e606fec42f909774ca4347e04b /docs/api.md | |
| parent | a253694c308b7b337c7d781c4bbfddefe4bfe53e (diff) | |
| download | dat-docs-17926b349a0ab5a761b0a97dde27f71a1e1f332e.tar.gz dat-docs-17926b349a0ab5a761b0a97dde27f71a1e1f332e.zip | |
Simplify tree (#19)
* simplify the doc tree
* add faq and cookbook
* add cookbook files
* update build script
* fix contents.json file
* more examples, fix startBytes
* add FAQ
* Examples-> cookbook
* update diy dat with more details and examples
* fix package.json update
* cleanup Dat capitalization + typos, fix #17
* format ecosystem page
* add example dat links and typo fixes
Diffstat (limited to 'docs/api.md')
| -rw-r--r-- | docs/api.md | 29 |
1 files changed, 0 insertions, 29 deletions
diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 68a7c3f..0000000 --- a/docs/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. |