Commit 6754317a6662887d6c7745f91080dbfab007325e
Update readme
- Note ssb-npm-registry - Add new screenshot - Update yearcel committed on 6/5/2018, 3:02:47 AM
Parent: bdbeb9c156a4c8b0e0ecd33e2613564c8491ee66
Files changed
README.md | changed |
README.md | |||
---|---|---|---|
@@ -9,17 +9,24 @@ | |||
9 | 9 … | - http://git.mixmix.io/ | |
10 | 10 … | ||
11 | 11 … | ## Install | |
12 | 12 … | ||
13 … | +Requirements: | ||
14 … | + | ||
15 … | +- [scuttlebot][] | ||
16 … | +- Connection to the [SSB network][Scuttlebutt] network | ||
17 … | +- [ssb-npm-registry][] scuttlebot plugin | ||
18 … | + | ||
19 … | +Install via ssb-npm: | ||
20 … | + | ||
13 | 21 … | ``` | |
14 | -npm install -g git-ssb-web | ||
22 … | +npm install -g git-ssb-web --registry=http://localhost:8043/ | ||
15 | 23 … | ``` | |
16 | - | ||
17 | 24 … | Or, if you also want the git remote helper and other goodies, install the | |
18 | 25 … | [git-ssb][] suite: | |
19 | 26 … | ||
20 | 27 … | ``` | |
21 | -npm install -g git-ssb | ||
28 … | +npm install -g git-ssb --registry=http://localhost:8043/ | ||
22 | 29 … | ``` | |
23 | 30 … | ||
24 | 31 … | ## Usage | |
25 | 32 … | ||
@@ -49,20 +56,25 @@ | |||
49 | 56 … | Set `computeIssueCounts` to `false` for faster start up. | |
50 | 57 … | ||
51 | 58 … | ## Screenshots | |
52 | 59 … | ||
60 … | +![screenshot](&f2f7WFd2qr2aKd5DFvYKZgmeSdJ3rayqQg0DxwLSCRg=.sha256) | ||
61 … | + | ||
53 | 62 … | ![screenshot of a user's activity](static/screenshot-user-activity.png) | |
54 | 63 … | ||
55 | 64 … | ![screenshot of a repo](static/screenshot-repo.png) | |
56 | 65 … | ||
57 | 66 … | ![screenshot of a pull request](static/screenshot-pr.png) | |
58 | 67 … | ||
68 … | +[Scuttlebutt]: https://www.scuttlebutt.nz/ | ||
69 … | +[scuttlebot]: https://scuttlebot.io/ | ||
59 | 70 … | [secure-scuttlebutt]: https://github.com/ssbc/secure-scuttlebutt | |
60 | 71 … | [git-ssb]: %n92DiQh7ietE+R+X/I403LQoyf2DtR3WQfCkDKlheQU=.sha256 | |
72 … | +[ssb-npm-registry]: %pFqjcdVKHqsrtOjVEAVZeCF0iY4s+3Hr0vA3EFCq5UM=.sha256 | ||
61 | 73 … | ||
62 | 74 … | ## License | |
63 | 75 … | ||
64 | -Copyright (c) 2016 Charles Lehner and contributors | ||
76 … | +Copyright (c) 2016-2018 Charles Lehner and contributors | ||
65 | 77 … | ||
66 | 78 … | Usage of the works is permitted provided that this instrument is | |
67 | 79 … | retained with the works, so that any entity that uses the works is | |
68 | 80 … | notified of this instrument. |
Built with git-ssb-web