Init

1 files changed, 92 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ede3d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+# patchfoo
+
+Plain SSB web UI. Uses HTML forms instead of client-side JS. Designed for use on low-power and low-resource computers.
+
+## Goals
+
+- Support all message schemas commonly used in the main SSB network.
+- Make efficient use of screen space, memory, and CPU.
+- Run well in [dillo](http://dillo.org/) browser.
+- Serve as a place for experimenting with new HTML-based SSB UIs.
+
+## Features
+
+- Render messages with author name and icons.
+- Render core ssb message types, git-ssb message types, and raw messages.
+- View public log, private log, user feeds, channels, and search.
+- Paginate views bidirectionally.
+- Compose, preview and publish public and private messages.
+
+## TODO
+
+- Support more message types (e.g. ferment).
+- Add a way to assist picking feed ids for `@mentions` in composer.
+- Show a list of channels.
+- Add more sophisticated private messages view.
+- Show contents of git repos (cross-develop with [patchbay])
+- Count digs
+- Show followers/followed on feed pages.
+  - Add form for (un)following feeds.
+- Show network status
+- Add UI for using pub invites
+
+## Install & Run
+
+As a sbot plugin:
+```sh
+cd ~/.ssb/node_modules
+git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo && cd patchfoo
+npm install --production
+sbot plugins.enable patchfoo
+# restart sbot
+```
+
+Or standalone:
+```sh
+git clone ssb://%YAg1hicat+2GELjE2QJzDwlAWcx0ML+1sXEdsWwvdt8=.sha256 patchfoo && cd patchfoo
+npm install
+npm start
+```
+
+## Config
+
+Pass config options with args
+e.g. `npm start -- --patchfoo.port 8027` if running standalone,
+or `sbot server --patchfoo.port 8027` if running as an sbot plugin.
+To make config options persistent, set them in `~/.ssb/config`, e.g.:
+```json
+{
+  "patchfoo": {
+    "port": 8027,
+    "host": "::"
+  }
+}
+```
+
+### Config options
+
+- `port`: port for the server to listen on. default: `8027`
+- `host`: host address for the server to listen on. default: `localhost`
+- `base`: base url that the app is running at. default: `/`
+- `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`
+
+[patchbay]: %s9mSFATE4RGyJx9wgH22lBrvD4CgUQW4yeguSWWjtqc=.sha256
+
+## License
+
+Copyright (C) 2017 Secure Scuttlebutt Consortium
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.