aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/README.md b/README.md
index 7d62994..e7d6e5a 100644
--- a/README.md
+++ b/README.md
@@ -30,14 +30,6 @@ npm run paper
This documentation uses [minidocs](https://github.com/freeman-lab/minidocs) for layout, [ecosystem-docs](https://github.com/hughsk/ecosystem-docs) to get documentation from other modules, and ideas from [pull-stream-docs](https://github.com/pull-stream/pull-stream-docs) for auto travis deployment.
-### Viewing Docs Locally
-
-1. Clone Repository
-2. `npm install`
-3. `npm run build:local` to build the docs for local viewing
-4. `npm run update` to update external modules
-4. `npm run start` to view the docs in browser
-
### Deployment
This repository uses [netlify](https://www.netlify.com/) for deployment. Deployment will happen automatically.
@@ -52,14 +44,20 @@ It works this way:
* runs `npm run netlify` which updates remote repos and builds.
* deploys `/dist` to the web
-### NPM Commands
+### Viewing Docs Locally
-#### Local Docs Preview:
+1. Clone Repository
+2. `npm install`
+3. `npm run update` to update external modules
+4. `npm run build:local` to build the docs for local viewing
+5. `npm run start` to view the docs in browser
-* `npm update`: update external module readme files
-* `npm run build:local`: build app & css for local viewing
-* `npm start`: start budo server to view locally
+### Ecosystem-docs Modules
-#### Other commands:
+Ecosystem-docs downloads readme files from the following modules to `docs/modules/`. Add another module to the documentation by adding the module below and updating `contents.json`: `"dat-node": "modules/dat-node.md"`. The 📔 makes it easier to parse (see `package.json`).
-* `n
+* 📔 [dat](https://github.com/datproject/dat)
+* 📔 [hyperdrive](https://github.com/mafintosh/hyperdrive)
+* 📔 [hypercore](https://github.com/mafintosh/hypercore)
+* 📔 [dat-node](https://github.com/datproject/dat-node)
+* 📔 [hyperdiscovery](https://github.com/karissa/hyperdiscovery)