aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 17 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4351681..92450bb 100644
--- a/README.md
+++ b/README.md
@@ -16,15 +16,12 @@ Plain SSB web UI. Uses HTML forms instead of client-side JS. Designed for use on
- View public log, private log, user feeds, channels, and search.
- Paginate views bidirectionally.
- Compose, preview and publish public and private messages.
+- *and more*
-## TODO
+## Joining SSB with Patchfoo
-- Add a way to assist picking feed ids for `@mentions` in composer.
-- Add more sophisticated private messages view.
-- Show contents of git repos (cross-develop with [patchbay])
-- Count digs
-- Show network status
-- Add UI for using pub invites
+Find [this guide](%VaSj08AbdhIa4itK4z8Z91G80o2h5OhRLCEEO6MhAcU=.sha256) [on github](https://github.com/noffle/sailing-patchfoo) or [on
+SSB](http://git.scuttlebot.io/%25VaSj08AbdhIa4itK4z8Z91G80o2h5OhRLCEEO6MhAcU%3D.sha256).
## Install & Run
@@ -48,12 +45,12 @@ sbot plugins.enable patchfoo
## Install extras
-To be able to render channels, patchfoo needs the `ssb-query` scuttlebot
+To most effectively render things, patchfoo needs the `ssb-backlinks` scuttlebot
plugin:
```sh
-sbot plugins.install ssb-query
-sbot plugins.enable ssb-query
+sbot plugins.install ssb-backlinks
+sbot plugins.enable ssb-backlinks
# restart sbot
```
@@ -80,6 +77,16 @@ To make config options persistent, set them in `~/.ssb/config`, e.g.:
- `blob_base`: base url for links to ssb blobs. default: same as `base`
- `img_base`: base url for blobs embedded as images. default: same as `base`
- `emoji_base`: base url for emoji images. default: same as `base`
+- `encode_msgids`: whether to URL-encode message ids in local links. default: `true`
+
+## TODO
+
+- Add a way to assist picking feed ids for `@mentions` in composer.
+- Add more sophisticated private messages view.
+- Show contents of git repos (cross-develop with [patchbay])
+- Count digs
+- Show network status
+- Add UI for using pub invites
[patchbay]: %s9mSFATE4RGyJx9wgH22lBrvD4CgUQW4yeguSWWjtqc=.sha256