Commit 390c2437a4420fe4ccd76e44d7446303ec78dcf9
update readme
Ev Bogue committed on 8/25/2016, 11:23:05 AMParent: 49c5f3b073d6460cf13ba1fb6930e02abc090c10
Files changed
| readme.md | changed |
| readme.md | ||
|---|---|---|
| @@ -1,11 +1,35 @@ | ||
| 1 | 1 | # sdash |
| 2 | 2 | |
| 3 | -Render your last Sbot post so you can toss it into an iFrame (YES AN IFRAME!!!) and throw it up on your static website. | |
| 3 | +sdash is a simple personal gateway to the [scuttlebot](http://scuttlebot.io) distributed social database | |
| 4 | 4 | |
| 5 | - % git clone | |
| 6 | - % npm install | |
| 7 | - % node index | |
| 5 | +### Install Scuttlebot | |
| 8 | 6 | |
| 9 | -Navigate to http://localhost:4000/ to see your latest Sbot status. | |
| 7 | +``` | |
| 8 | +sudo npm install -g scuttlebot | |
| 9 | +scuttlebot server | |
| 10 | +``` | |
| 10 | 11 | |
| 11 | -This app requires a local install of Scuttlebot to run. | |
| 12 | +Next, request a Scuttlebot invite from [someone on the network](mailto:ev@evbogue.com) | |
| 13 | + | |
| 14 | +In another window | |
| 15 | + | |
| 16 | +``` | |
| 17 | +sbot plugins.install ssb-ws | |
| 18 | +sbot plugins.install query | |
| 19 | +sbot plugins.install links | |
| 20 | +``` | |
| 21 | + | |
| 22 | +And restart sbot after the plugins are installed using `ctrl-c` and `scuttlebot server` | |
| 23 | + | |
| 24 | +To launch sdash clone it down | |
| 25 | + | |
| 26 | +``` | |
| 27 | +sudo npm install -g git-ssb | |
| 28 | +git clone ssb://%qrU04j9vfUJKfq1rGZrQ5ihtSfA4ilfY3wLy7xFv0xk=.sha256 sdash | |
| 29 | +cd sdash | |
| 30 | +npm install | |
| 31 | +node index | |
| 32 | +``` | |
| 33 | + | |
| 34 | +and navigate to [http://localhost:7000](http://localhost:7000) | |
| 35 | + | |
Built with git-ssb-web