Merge remote-tracking branch 'origin/master' into ssb-legacy-conn

Author: christianbundy

.github/stale.yml

@@ -1,11 +1 @@
 _extends: .github
-
-# Issues with these labels will never be considered stale
-# This overrides `exemptLabels` from https://github:ssbc/.github
-exemptLabels:
-  - pinned
-  - security
-  - enhancement
-  - bug
-  - performance
-

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+dist
 
 # Mac OS metadata file
 .DS_Store

.travis.yml

@@ -1,19 +1,46 @@
-sudo: false
+matrix: 
+  include:
+    - os: osx
+      osx_image: xcode9.4
+      language: node_js
+      node_js: lts/*
+      env:
+        - ELECTRON_CACHE=$HOME/.cache/electron
+        - ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
+  
+    - os: linux
+      language: node_js
+      node_js: lts/*
 
-language: node_js
+    - os: windows
+      language: node_js
+      node_js: lts/*
+      filter_secrets: false
+
+cache:
+  directories:
+    - $HOME/.npm
+    - $HOME/.cache/electron
+    - $HOME/.cache/electron-builder
 
 before_install:
-  - npm install -g npm@latest
-  - sudo apt-get -qq update
-  - sudo apt-get install -y g++ m4 libtool automake libgconf-2-4    # build tools
-  - sudo apt-get install -y libxext-dev libxtst-dev libxkbfile-dev  # spellchecker headers
+  - |
+    if [ "$TRAVIS_OS_NAME" == "linux" ]; then
+      sudo apt-get install \
+        automake \
+        libgconf-2-4 \
+        libtool \
+        libxext-dev \
+        libxkbfile-dev \
+        libxtst-dev
+    else
+      npm uninstall --save mouse-forward-back
+    fi
+
+script: npm test && npm run dist
 
-node_js:
-  - 4
-  - 5
-  - 6
-  - 7
-  - stable
 
-script:
-  - pwd   # run no-op to prevent failure from no tests
+branches:
+  only:
+  - master
+  - "/^v\\d+\\.\\d+\\.\\d+$/"

.vscode/settings.json

@@ -4,7 +4,6 @@
         "abouts",
         "backlinks",
         "depnest",
-        "emojilib",
         "flatpickr",
         "msgs",
         "paramap",
@@ -18,4 +17,4 @@
     ],
     "standard.autoFixOnSave": true,
     "editor.tabSize": 2
-}
+}

README.md

@@ -1,103 +1,69 @@
-<h1 align="center">
-  <img
-    alt="Patchwork icon"
-    src="https://github.com/ssbc/patchwork/blob/0465f406357cec9cdb8d821f68758d7ab8ef41cf/assets/icon.png"
-    width="256"
-    height="256"
-  />
-  <br />
-  Patchwork
-</h1>
+# Patchwork
 
-<h4 align="center">
-  A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB).
-</h4>
+> A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB).
 
-![Patchwork screenshot](screenshot.jpg)
+- Connect with friends without depending on any central servers.
+- Don't worry about spam, you only get messages from people you follow.
+- Use Patchwork online or offline, the data you need is stored on your device.
+- Sync messages with friends when you're on the same Wi-Fi network.
+- Keep secrets with private messages, which are *always* end-to-end encrypted.
+- Change and improve Patchwork however you'd like, it's free and open source.
 
-<details>
-  <summary>Table of Contents</summary>
-  <li><a href="#features">Features</a></li>
-  <li><a href="#pubs">Pubs</a></li>
-  <li><a href="#install">Install</a></li>
-  <li><a href="#docs">Docs</a></li>
-</details>
+## Usage
 
-## Features
+![Screenshot of Patchwork][screenshot]
 
-It's better than email because:
+New to Scuttlebutt? Join the network by connecting to a [pub][pub].
 
- - Private messages are end-to-end encrypted, always.
- - You have to follow somebody to get messages from them, so you won't get spammed.
- - Your mail can be public broadcasts or private, and you'll only see replies by people you follow.
- - The datastructure is a global mesh of append-only logs, which can support new types of data (not just "mail").
- - Users are not bound to one server/host (what we call "Pubs") and do not have to trust the servers.
- - It's very easy to setup and maintain your own Pub.
+1. Choose a pub from the [pub list][pub-list] and copy an invite code.
+2. Open Patchwork and select *Join Pub*.
+3. Paste the invite code and select *Redeem Invite*.
 
-It's better than Twitter and Facebook because:
+You're done! Check out `#new-people` to see who else has recently joined.
 
- - Private messages are end-to-end encrypted, always.
- - The software runs on your device, so there's nobody tracking your browsing.
- - The application code is FOSS, so you're free to fork or write new applications without a gatekeeper setting terms.
- - Data is saved to your disk, and so the application works offline.
- - You can sync directly with friends over Wi-Fi.
+## Installation
 
-## Pubs
+Most people should **[download Patchwork for Windows, macOS, or Linux][gh-dl]**.
 
-In order to gossip outside your local network, you'll need to connect to a [Pub](https://www.scuttlebutt.nz/concepts/pub.html).
+Alternatively, you can install Patchwork with your favorite package manager.
 
-You can find an invite to an available pub at the [Pub servers registry](https://github.com/ssbc/ssb-server/wiki/Pub-Servers).
+- **[npm][npm]:** `npm install --global ssb-patchwork`
+- **[yarn][yarn]:** `yarn global add ssb-patchwork`
+- **[yay][yay]:** `yay -S ssb-patchwork`
 
-Get an invite, then in `patchwork`: click "+ Join Pub" and paste the invite code.
-
-This will cause you to follow the Pub and vice versa. If you haven't synchronized to this social network yet, prepare to wait a few minutes while your local server synchronizes.
-
-## Install
-
-### Download installers for Windows, macOS and Linux
-
-See [patchwork/releases](https://github.com/ssbc/patchwork/releases)
-
-### Or build from source
-
-With node (>= 4) and npm (>= 3) installed:
-
-```shell
-$ git clone https://github.com/ssbc/patchwork
-$ cd patchwork
-$ npm install
-$ npm start
-```
-
-You'll need some more dependencies to build.
-
-On Debian Linux:
-
-```shell
-sudo apt-get install g++ m4 libtool automake libgconf-2-4   # build tools
-sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev # spellchecker headers
-```
-
-On Fedora Linux:
-
-```shell
-sudo dnf install libXext-devel libXtst-devel libxkbfile-devel gcc-c++ m4 automake libtool
-```
-
-On macOS:
-
-```shell
-brew install libtool automake # build tools
-```
-
-## Code of conduct
-
-Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
+Building from source? Check out [`INSTALL.md`][install] for more information.
 
 ## Contributing
 
-Please read the [Patchwork Contribution Guidelines](contributing.md) before opening a pull request.
-
-## Docs
-
-- [scuttlebutt.nz](https://www.scuttlebutt.nz)
+Create a [new issue][new-issue] to report problems or request features. See
+[`CONTRIBUTING.md`][contributing] for more information on how to get involved.
+
+Please note that this project is released with a [Contributor Code of
+Conduct][conduct]. By participating in this project you agree to abide by its
+terms.
+
+## See Also
+
+- [patchbay][patchbay]
+- [ssb-server][ssb-server]
+- [manyverse][manyverse]
+
+## License
+
+[AGPL-3.0][license]
+
+[conduct]: docs/CODE_OF_CONDUCT.md
+[contributing]: docs/CONTRIBUTING.md
+[gh-dl]: https://github.com/ssbc/patchwork/releases/latest
+[install]: docs/INSTALL.md
+[license]: LICENSE
+[manyverse]: https://gitlab.com/staltz/manyverse
+[new-issue]: https://github.com/fraction/readme-boilerplate/issues/new
+[npm]: https://npmjs.org/
+[patchbay]: https://github.com/ssbc/patchbay
+[pub-list]: https://github.com/ssbc/ssb-server/wiki/Pub-Servers
+[pub]: https://www.scuttlebutt.nz/concepts/pub.html
+[screenshot]: assets/screenshot.jpg
+[ssb-server]: https://github.com/ssbc/ssb-server
+[yarn]: https://yarnpkg.com/en/
+[yay]: https://github.com/Jguer/yay