Commit 4e7a3a4c0b9ff50a3a59087217db6efdafc92d61
updated readme
austinfrey committed on 1/18/2019, 2:10:39 PMParent: 8a55ce7a0a9c8d857b3bf814582e7c20674d2f22
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -1,7 +1,19 @@ | |||
| 1 | 1 … | # double | |
| 2 | -double entry accounting app | ||
| 2 … | +double entry accounting app. inspired by (hypercore-accounting) and uses | ||
| 3 … | +ssb/flume modules instead of hypercore. | ||
| 3 | 4 … | ||
| 5 … | +# warning | ||
| 6 … | +this repo is a mess. `master` branch has a prototype working with | ||
| 7 … | +FlumeDB. the `sbot-db` has a prototype working with scuttlebutt. | ||
| 8 … | + | ||
| 9 … | +neither of these branches should be viewed as usable. they _should_ be | ||
| 10 … | +viewed as experimental. when using with scuttlebutt it is highly | ||
| 11 … | +recommended that you do so on a test net. you can find instructions for | ||
| 12 … | +setting up sbot on a test net in the great article by Josiah Witt: | ||
| 13 … | +dat://wittjosiah.hashbase.io/2018/07/08/scuttlebutt-intro-test-playground.html | ||
| 14 … | + | ||
| 15 … | + | ||
| 4 | 16 … | ## Commands | |
| 5 | 17 … | Command | Description | | |
| 6 | 18 … | -----------------------|--------------------------------------------------| | |
| 7 | 19 … | `$ npm run electro` | start electron application | |
Built with git-ssb-web