aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKarissa McKelvey <krmckelv@gmail.com>2016-01-11 00:29:42 -0800
committerKarissa McKelvey <krmckelv@gmail.com>2016-01-11 00:29:42 -0800
commitce225a4d59ca8713baf3c956179cb9783b30363c (patch)
treee478be5bcc2b89d167dca93d055635cac4fbb491 /README.md
parent8b98e2331d7d1f83a27db3753040d9382c357573 (diff)
downloaddat-docs-ce225a4d59ca8713baf3c956179cb9783b30363c.tar.gz
dat-docs-ce225a4d59ca8713baf3c956179cb9783b30363c.zip
move tech docs to index
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index a8f5ea9..d034973 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
Documentation resources for upcoming [dat](https://github.com/maxogden/dat) 1.0 release and the surrounding ecosystem.
+## Hosting
+
+By default, dat looks to host on port 3282, and if taken, will choose a random open port.
+
+## Hidden folder
+
+Dat stores its data in a hidden folder that is stored by default in the user's home directory.
+
+```
+~/.dat
+```
+
+Because of this, data is only ever downloaded once. That is, if you have multiple projects that use the same data (perhaps at different versions) on the same machine, dat will first check the global `.dat` folder.
+
+The global `.dat` folder has inside:
+
+```
+$ ls ~/.dat
+db
+config.json
+```
+
## Dat dependency overview
#### [hyperdrive](https://github.com/mafintosh/hyperdrive)
@@ -11,3 +33,4 @@ The file sharing network dat uses to distribute files and data. A technical spec
#### [discovery-channel](https://github.com/maxogden/discovery-channel)
This is the module dat uses to find peers on the local network or the internet who are sharing the same files and data that you are.
+