Commit 4aa133a211115e9955380ca246d7ad14324aed7b
a README (#436)
* mush together a README * fix icon * fix table of contents * use pub server registryMikey authored on 3/16/2017, 2:22:05 PM
GitHub committed on 3/16/2017, 2:22:05 PM
Parent: 0174747544661e12905d13155a2a994d4d93cab5
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -1,14 +1,64 @@ | ||
| 1 | -# patchwork | |
| 1 | +<h1 align="center"> | |
| 2 | + <img | |
| 3 | + alt="Patchwork icon" | |
| 4 | + src="https://github.com/ssbc/patchwork-icons/raw/master/rainbow-hermies/256x256.png" | |
| 5 | + width="256" | |
| 6 | + height="256" | |
| 7 | + /> | |
| 8 | + <br /> | |
| 9 | + Patchwork | |
| 10 | +</h1> | |
| 2 | 11 | |
| 3 | -A remake of [Patchwork Classic](https://github.com/ssbc/patchwork-classic) using [patchcore](https://github.com/ssbc/patchcore) and UX/ideas from [ferment](https://github.com/mmckegg/ferment). | |
| 12 | +<h4 align="center"> | |
| 13 | + A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB). | |
| 14 | +</h4> | |
| 4 | 15 | |
| 5 | -The goal is to make a standalone, easy to install, "social" view into the ssb world. | |
| 6 | - | |
| 7 | 16 |  |
| 8 | 17 | |
| 9 | -## Install and run | |
| 18 | +<details> | |
| 19 | + <summary>Table of Contents</summary> | |
| 20 | + <li><a href="#features">Features</a></li> | |
| 21 | + <li><a href="#pubs">Pubs</a></li> | |
| 22 | + <li><a href="#install">Install</a></li> | |
| 23 | + <li><a href="#docs">Docs</a></li> | |
| 24 | +</details> | |
| 10 | 25 | |
| 26 | +## Features | |
| 27 | + | |
| 28 | +It's better than email because: | |
| 29 | + | |
| 30 | + - Private messages are end-to-end encrypted, always. | |
| 31 | + - You have to follow somebody to get messages from them, so you won't get spammed. | |
| 32 | + - Your mail can be public broadcasts or private, and you'll only see replies by people you follow. | |
| 33 | + - The datastructure is a global mesh of append-only logs, which can support new types of data (not just "mail"). | |
| 34 | + - Users are not bound to one server/host (what we call "pubs") and do not have to trust the servers. | |
| 35 | + - It's very easy to setup and maintain your own pub. | |
| 36 | + | |
| 37 | +It's better than twitter and facebook because: | |
| 38 | + | |
| 39 | + - Private messages are end-to-end encrypted, always. | |
| 40 | + - The software runs on your device, so there's nobody tracking your browsing. | |
| 41 | + - The application-code is FOSS, so you're free to fork or write new applications without a gatekeeper setting terms. | |
| 42 | + - Data is saved to your disk, and so the application works offline. | |
| 43 | + - You can sync directly with friends over the wifi. | |
| 44 | + | |
| 45 | +## Pubs | |
| 46 | + | |
| 47 | +In order to gossip outside your local network, you'll need to connect to a [Pub](https://www.scuttlebutt.nz/concepts/pub.md). | |
| 48 | + | |
| 49 | +You can find an invite to an available pub at the [Pub servers registry](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers). | |
| 50 | + | |
| 51 | +Get an invite, then in `patchwork`: click "+ Join Pub" and paste the invite code. | |
| 52 | + | |
| 53 | +This will cause you to follow the Pub and vise versa. If you haven't synchronized to this social network yet, prepare to wait a few minutes while your local server synchronizes. | |
| 54 | + | |
| 55 | +## Install | |
| 56 | + | |
| 57 | +Download installers for Windows, macOS and Linux from [patchwork/releases](https://github.com/ssbc/patchwork/releases) | |
| 58 | + | |
| 59 | +Or you can build from source with node and npm installed: | |
| 60 | + | |
| 11 | 61 | ```shell |
| 12 | 62 | $ git clone https://github.com/ssbc/patchwork |
| 13 | 63 | $ cd patchwork |
| 14 | 64 | $ npm install |
| @@ -16,31 +66,12 @@ | ||
| 16 | 66 | ``` |
| 17 | 67 | |
| 18 | 68 | On linux you'll need some more dependencies for the spell-checker. On debian: |
| 19 | 69 | |
| 20 | -```sh | |
| 70 | +```shell | |
| 21 | 71 | sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev |
| 22 | 72 | ``` |
| 23 | 73 | |
| 24 | -## TODO | |
| 74 | +## Docs | |
| 25 | 75 | |
| 26 | -- [x] Main navigation buttons | |
| 27 | -- [x] Compressed feed (the algorithm :wink:) | |
| 28 | -- [x] Endless scrolling (or load more) on main feed [fake paginate, add a new section, leave the current one and remove the top most] | |
| 29 | -- [x] Display fixed banner at top of view when there are new updates [scrolls to top of page and reloads view when clicked] | |
| 30 | -- [x] Preserve scroll on back button | |
| 31 | -- [x] Treat the different "views" more like tabs. They preserve their state when switched between [scroll position, forms]. | |
| 32 | -- [x] Show likes on posts in a nicer way (make it clear that you've liked something) | |
| 33 | -- [x] Hovering "+1" like values and "x other people" messages should show who | |
| 34 | -- [x] Display number of updates available on Feed buttons. Clicking reloads page. | |
| 35 | -- [x] Improve UI on profiles | |
| 36 | - - [x] Move contacts to sidebar | |
| 37 | - - [x] Better selection of names / avatar | |
| 38 | -- [x] Figure out when to automatically reload / or inject changes into feeds | |
| 39 | -- [x] "Join Pub" interface | |
| 40 | -- [x] Improve search UI | |
| 41 | -- [ ] Reload should remember current page | |
| 42 | -- [ ] Roll-up about messages | |
| 43 | -- [ ] Handle initial sync more gracefully | |
| 44 | -- [ ] Easy navigation sidebar | |
| 45 | -- [ ] Contacts sidebar | |
| 46 | -- [ ] Add more todos! | |
| 76 | +- [scuttlebutt.nz](https://www.scuttlebutt.nz) | |
| 77 | +- [scuttlebot.io](https://scuttlebot.io) | |
Built with git-ssb-web