Commit 1b92defc7a364a894997eabdeefb6b94f0c1230b
update readme with plugins link
mix irving committed on 1/12/2018, 10:11:06 PMParent: 29cd9468499dec20d72aabeb0bfb5384ce91230b
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -3,26 +3,33 @@ | |||
| 3 | 3 … | An introduction to flumeDb - the database under secure scuttlebutt. Also, mix is a dragon onsie | |
| 4 | 4 … | ||
| 5 | 5 … | Learn about the basics of Flume, and how to make a materialised view with it. | |
| 6 | 6 … | ||
| 7 | -check out a wide range of scuttlebutt learning resources here : | ||
| 8 | -https://github.com/ssbc/scuttlebutt-guide | ||
| 7 … | +Check out a wide range of scuttlebutt learning resources here : **scuttlebutt-guide** ([ssb](%rRmgg8grYJ/upfXKxFNG62Y49CmkEShk70HoFLIEyDY=.sha256) | [github](https://github.com/ssbc/scuttlebutt-guide)) | ||
| 9 | 8 … | ||
| 10 | -## Video | ||
| 9 … | +[](https://youtu.be/f_baWUW4R8Y) | ||
| 11 | 10 … | ||
| 12 | 11 … | Recording of the stream: https://youtu.be/f_baWUW4R8Y | |
| 13 | 12 … | ||
| 14 | -[](https://youtu.be/f_baWUW4R8Y) | ||
| 13 … | +## HOWTO | ||
| 15 | 14 … | ||
| 16 | -## TODO | ||
| 15 … | +clone this repo down and run `npm install` | ||
| 17 | 16 … | ||
| 18 | -I've yet to write up some links and resouces. Come back for those later | ||
| 17 … | +From there you can run each of these files in the terminal, e.g.: | ||
| 19 | 18 … | ||
| 19 … | +```js | ||
| 20 … | +node 1_write_to_flume.js | ||
| 21 … | +``` | ||
| 20 | 22 … | ||
| 23 … | +Note that at the end of this I hit some bumps trying to install the flumeview as a scuttlebot plugin. | ||
| 24 … | +I managed to resolve that after the stream, you can check it out here : ([ssb](%f2PZYbacgJpNq4buNCVsjG6j55K8olw80QxPjF2Teqs=.sha256) | [github](https://www.github.com:mixmix/ssb-server-plugin-intro)) | ||
| 25 … | + | ||
| 26 … | + | ||
| 21 | 27 … | ## PREP | |
| 22 | 28 … | ||
| 23 | 29 … | - check out the `dry_run` branch and have a read of the code ahead of time if you like | |
| 24 | 30 … | - brush up on the basic use of `pull-stream` | |
| 25 | 31 … | ||
| 26 | 32 … | resources: | |
| 27 | 33 … | - https://github.com/ssbc/scuttlebutt-guide | |
| 34 … | +- how to install a flumeview as an scuttlebot plugin : ([ssb](%f2PZYbacgJpNq4buNCVsjG6j55K8olw80QxPjF2Teqs=.sha256) | [github](https://www.github.com:mixmix/ssb-server-plugin-intro)) | ||
| 28 | 35 … | ||
Built with git-ssb-web