Commit 8e8d7724b8b3a47eb89a94da1279f04f396e7bac
Document lite usage
Anders Rune Jensen committed on 12/18/2016, 12:38:52 PMParent: 66f1a12dfe0245c72e4092b63782428b6eceabbf
Files changed
README.md | changed |
README.md | |||
---|---|---|---|
@@ -38,8 +38,27 @@ | |||
38 | 38 … | npm run bundle | |
39 | 39 … | npm start | |
40 | 40 … | ``` | |
41 | 41 … | ||
42 … | +## Lite | ||
43 … | + | ||
44 … | +To run a lite client in the browser instead of using electron, use npm | ||
45 … | +run lite from the prompt instead of run bundle. After that you need to | ||
46 … | +generate a modern invite: | ||
47 … | + | ||
48 … | +``` | ||
49 … | +sbot invite.create --modern | ||
50 … | +``` | ||
51 … | + | ||
52 … | +Also set up sbot to allow these connections with: | ||
53 … | + | ||
54 … | +``` | ||
55 … | +sbot server --allowPrivate | ||
56 … | +``` | ||
57 … | + | ||
58 … | +Lastly open build/index.html in a browser and append the invite | ||
59 … | +created above using: index.html#ws://localhost:8989.... | ||
60 … | + | ||
42 | 61 … | ## how to add a feature | |
43 | 62 … | ||
44 | 63 … | To add a new message type, add add a js to `./modules/` that | |
45 | 64 … | exports a function named `message_content` (it should return an html element) |
Built with git-ssb-web