aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJoe Hand <joe@joeahand.com>2016-06-28 17:14:27 -0700
committerJoe Hand <joe@joeahand.com>2016-06-28 17:14:27 -0700
commit7cb7c667d14354146ef6fc23636d1faf4baaf376 (patch)
treeb5351305310eae14a72bdda0b9193d175d944f57 /README.md
parent299384a41f32be0336168c1592cd998147495f6b (diff)
downloaddat-docs-7cb7c667d14354146ef6fc23636d1faf4baaf376.tar.gz
dat-docs-7cb7c667d14354146ef6fc23636d1faf4baaf376.zip
add general info to welcome and use as index
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4137287..fdc011c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,23 @@
-# Documentation for the Dat ecosystem
+## Dat Project Documentation
+
+Repository for the documentation of the Dat Project ecosystem. View the docs at [docs.dat-data.com](http://docs.dat-data.com).
+
+[![#dat IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23dat%20on%20freenode-blue.svg)](http://webchat.freenode.net/?channels=dat)
+[![datproject/discussions](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/datproject/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![docs](https://img.shields.io/badge/Dat%20Project-Docs-green.svg)](http://docs.dat-data.com)
+
+## Writing & Editing Docs
+
+This documentation uses [minidocs](https://www.npmjs.com/package/minidocs).
+
+The table of contents is in `content.json`.
+
+### Installation & Usage
+
+1. Clone Repository
+2. `npm install`
+3. `npm run build` to build the docs.
+4. `npm run deploy` to deploy docs to GitHub pages.
## License