diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -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). + +[](http://webchat.freenode.net/?channels=dat) +[](https://gitter.im/datproject/discussions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[](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 |