Commit 884eb5a57e543ca9344329d6f554bee248ddc66e
update readme
Ev Bogue committed on 4/20/2018, 12:28:25 PMParent: b841ee31c64281cfb19407453fbbef54f5ef6e95
Files changed
readme.md | changed |
readme.md | ||
---|---|---|
@@ -1,10 +1,23 @@ | ||
1 | -### | |
1 … | +# mvd | |
2 | 2 … | |
3 | 3 … | This is a minimum viable full-stack Decent server and client. |
4 | 4 … | |
5 | -It is very basic. | |
5 … | +Or you can call it model/view/decent | |
6 | 6 … | |
7 | -Have fun with it! | |
7 … | +`scuttlebot.js` is the model | |
8 … | +`views.js` is the views | |
9 … | +`index.js` is the controller | |
10 … | +and | |
11 … | +`render.js` renders posts | |
8 | 12 … | |
13 … | +### getting started | |
14 … | +``` | |
15 … | +npm install | |
16 … | +npm run build | |
17 … | +npm start | |
18 … | +``` | |
19 … | + | |
20 … | +It should launch a browser window, and comes pre-configured to use the main ssb network by default. If you already have an `.ssb` folder, mvd should 'just work'. | |
21 … | + | |
9 | 22 … | --- |
10 | 23 … | MIT |
Built with git-ssb-web