diff options
| -rw-r--r-- | README.md | 62 | ||||
| -rw-r--r-- | contents.json | 2 | ||||
| -rw-r--r-- | package.json | 6 | ||||
| -rw-r--r-- | welcome.md | 61 |
4 files changed, 68 insertions, 63 deletions
@@ -1,61 +1,5 @@ -# Dat 1.0 docs +# Documentation for the Dat ecosystem -Documentation resources for [dat](https://github.com/maxogden/dat) 1.0 release candidate 1 and the surrounding ecosystem. +## License -## Installation - -``` -npm install -g dat -``` - -## Sharing data - -Dat is a peer to peer file sharing tool. To share data, first `cd` into a directory you want to share, and type: - -``` -$ dat link -``` - -This will create a link, that looks like `dat://...`. This is a unique hash, generated by the contents of the files (including those in subdirectories) inside the current directory. Dat ignores hidden files. - -Your output might look something like this: - -``` -$ dat link -Scanning folder, found 98 files in 5 directories. 47.12 MB total. -dat://a9933c3d00e1134e5814a0fe2b0f1166885f523dfe0d135a39a2ca4b43840d83 -Serving data (1 connection(s)) -``` - -On another computer, I can type: - -``` -dat dat://a9933c3d00e1134e5814a0fe2b0f1166885f523dfe0d135a39a2ca4b43840d83 -``` - -And the files will be downloaded inside of the current directory. The process will stay open, re-hosting the data to ensure redundancy of the data. - -## Versioning - -If you change any file inside the directory, you will get a different link. Each link is unique to the file list and data contents inside each file. - -Everything about the filesystem is replicated between two dat hosts, including directory structure, file modes, among other filesystem metadata. For example, changing the file mode of a single file will create an entirely different link. - -## Peer Discovery - -Dat uses a variety of different methods to discover peers that have the data it's looking for, including DNS, Multicast DNS, UDP, and TCP. See [discovery-swarm](https://github.com/mafintosh/discovery-swarm) for more information. - -## Local storage - -Dat stores its data in a hidden folder that is stored by default in the user's home directory. - -``` -~/.dat -``` -The global `.dat` folder has the following contents: - -``` -$ ls ~/.dat -db -config.json -``` +ISC diff --git a/contents.json b/contents.json index c67dfeb..07441c6 100644 --- a/contents.json +++ b/contents.json @@ -1,6 +1,6 @@ { "Introduction": { - "Welcome to Dat": "README.md", + "Welcome to Dat": "welcome.md", "How Dat works": "how-dat-works.md" }, "Ecosystem": { diff --git a/package.json b/package.json index 5854510..3efa4aa 100644 --- a/package.json +++ b/package.json @@ -5,8 +5,8 @@ "main": "index.js", "scripts": { "update": "curl -Ssl https://raw.githubusercontent.com/clkao/awesome-dat/master/readme.md | grep '📔' | egrep -o 'github.com/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+' | cut -f 2- -d / | uniq > repos.txt", - "build": "minidocs . -c contents.json -p -o dist -l dat-data.png -t 'The Dat Project' -s styles.css", - "deploy": "gh-pages -d dist", + "build": "minidocs . -c contents.json -p -o dist -l dat-data.png -t 'The Dat Project' -s styles.css", + "deploy": "echo docs.dat-data.com > dist/CNAME && gh-pages -d dist", "paper": "pandoc --variable author=\"Maxwell Ogden, Karissa McKelvey, Mathias Buus\" --variable title=\"Dat - Distributed Dataset Synchronization And Versioning\" --variable date=\"Version 1.0.0, May 2016\" --variable classoption=twocolumn --variable papersize=a4paper -s dat-paper.md -o dat-paper.pdf" }, "repository": { @@ -22,7 +22,7 @@ "homepage": "https://github.com/datproject/docs#readme", "dependencies": { "gh-pages": "^0.11.0", - "minidocs": "^2.0.1" + "minidocs": "^2.0.3" }, "devDependencies": { "ecosystem-docs": "^1.1.1" diff --git a/welcome.md b/welcome.md new file mode 100644 index 0000000..656e83c --- /dev/null +++ b/welcome.md @@ -0,0 +1,61 @@ +# Dat 1.0 docs + +Documentation resources for [dat](https://github.com/maxogden/dat) 1.0 release candidate 1 and the surrounding ecosystem. + +## Installation + +``` +npm install -g dat +``` + +## Sharing data + +Dat is a peer to peer file sharing tool. To share data, first `cd` into a directory you want to share, and type: + +``` +$ dat link +``` + +This will create a link, that looks like `dat://...`. This is a unique hash, generated by the contents of the files (including those in subdirectories) inside the current directory. Dat ignores hidden files. + +Your output might look something like this: + +``` +$ dat link +Scanning folder, found 98 files in 5 directories. 47.12 MB total. +dat://a9933c3d00e1134e5814a0fe2b0f1166885f523dfe0d135a39a2ca4b43840d83 +Serving data (1 connection(s)) +``` + +On another computer, I can type: + +``` +dat dat://a9933c3d00e1134e5814a0fe2b0f1166885f523dfe0d135a39a2ca4b43840d83 +``` + +And the files will be downloaded inside of the current directory. The process will stay open, re-hosting the data to ensure redundancy of the data. + +## Versioning + +If you change any file inside the directory, you will get a different link. Each link is unique to the file list and data contents inside each file. + +Everything about the filesystem is replicated between two dat hosts, including directory structure, file modes, among other filesystem metadata. For example, changing the file mode of a single file will create an entirely different link. + +## Peer Discovery + +Dat uses a variety of different methods to discover peers that have the data it's looking for, including DNS, Multicast DNS, UDP, and TCP. See [discovery-swarm](https://github.com/mafintosh/discovery-swarm) for more information. + +## Local storage + +Dat stores its data in a hidden folder that is stored by default in the user's home directory. + +``` +~/.dat +``` +The global `.dat` folder has the following contents: + +``` +$ ls ~/.dat +db +config.json +``` |