Commit e01e3e9d149b313350f8192379de989525862cbe
updated README with linux docs
dust committed on 4/5/2016, 6:47:18 AMParent: 6aea1b7fdb60e1780423d59193a6c90bb5e517f0
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -1,29 +1,52 @@ | ||
| 1 | 1 | # capsule |
| 2 | 2 | |
| 3 | 3 | ## how to use |
| 4 | 4 | |
| 5 | +### set up a URI handler for protocol ssb-capsule | |
| 6 | + | |
| 7 | +put something like this in ~/.local/share/applications (linux): | |
| 8 | + | |
| 9 | +``` | |
| 10 | +[Desktop Entry] | |
| 11 | +Name=capsule | |
| 12 | +GenericName=capsuleURI | |
| 13 | +X-GNOME-FullName=capsule URI handler | |
| 14 | +Comment=send capsule URI text to sbot | |
| 15 | +Exec=/home/user/capsule/os/parser %u | |
| 16 | +Terminal=false | |
| 17 | +NoDisplay=true | |
| 18 | +Type=Application | |
| 19 | +StartupNotify=true | |
| 20 | +MimeType=x-scheme-handler/ssbcapsule | |
| 21 | +Categories=Network;P2P | |
| 22 | +``` | |
| 23 | + | |
| 24 | +### install addon and use | |
| 25 | + | |
| 5 | 26 | 2. `git clone` |
| 6 | 27 | 1. `npm install` |
| 7 | 28 | 2. `npm build` |
| 8 | 29 | 3. visit chrome extensions menu (chrome://extensions) |
| 9 | 30 | 4. check developer mode checkbox |
| 10 | -5. load unpacked extension | |
| 31 | +5. load unpacked extension from capsule/chromium | |
| 11 | 32 | 6. visit a tab |
| 12 | 33 | 7. select some things |
| 13 | -8. click the addon icon (it's the 'hello' default right now) | |
| 34 | +8. click the addon icon | |
| 35 | +9. type some fun comments | |
| 36 | +10. choose a channel/topic it should be filed under | |
| 37 | +11. hit send | |
| 38 | +12. share your new cypherspace reblogging exploits | |
| 14 | 39 | |
| 15 | -nothing works past here yet :\ | |
| 16 | 40 | |
| 17 | - | |
| 18 | 41 | ## TODO |
| 19 | 42 | |
| 20 | 43 | - [x] strip out non-UI code from addon |
| 21 | 44 | - [x] build proper fork of [ssbify](https://github.com/krl/ssbify) that takes an |
| 22 | 45 | html string |
| 23 | 46 | - see [ssbify-string](https://github.com/du5t/ssbify-string) |
| 24 | -- [ ] write parser/handler script using above fork | |
| 25 | -- [ ] add comment field to serialiser and parser | |
| 47 | +- [x] write parser/handler script using above fork | |
| 48 | +- [x] add comment field to serialiser and parser | |
| 26 | 49 | - [ ] automate |
| 27 | 50 | xdg-open/open/[windows registry horror](https://msdn.microsoft.com/en-us/library/aa767914(v=vs.85).aspx) |
| 28 | 51 | registration |
| 29 | 52 | - [ ] document |
| @@ -34,4 +57,5 @@ | ||
| 34 | 57 | |
| 35 | 58 | - icon adapted from |
| 36 | 59 | [open clipart](http://colouringbook.org/art/svg/coloring-book/sputnik-comic-satellite-electronics-coloring-book-colouring-scallywag-coloring-book-colouring-sheet-coloring-book-colouring-page-colouringbook-org-svg) |
| 37 | 60 | - [ssbify](https://github.com/krl/ssbify) |
| 61 | +- DOM extractor from [SnappySnippet](https://github.com/kdzwinel/SnappySnippet/) | |
Built with git-ssb-web