Merge pull request #144 from soapdog/escape-the-browser

Escape the browser

Author: soapdog

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build/release
+
+on: push
+
+jobs:
+  release:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v1
+
+      - name: Install Node.js, NPM and Yarn
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - name: Build/release Electron app
+        uses: samuelmeuli/action-electron-builder@v1
+        with:
+          # GitHub token, automatically provided to the action
+          # (No need to define this secret in the repo settings)
+          github_token: ${{ secrets.github_token }}
+
+          # If the commit is tagged with a version (e.g. "v1.0.0"),
+          # release the app after building
+          release: ${{ startsWith(github.ref, 'refs/tags/v') }}
+
+          # Maybe this works
+          args: "--config electron-builder.config.js"

.gitignore

@@ -5,11 +5,16 @@ node_modules
 web-ext-artifacts
 *.zip
 old-src
+build
 
 \#*
 .vscode
 test/
 old/
+desktop-old/
 
 *.sublime-workspace
 .vscode
+reference-*
+
+*.tgz

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 First and foremost, thanks a lot for the interest in contributing to this little project. We really appreciate that.
 
-Your first stop is the [development documentation](https://patchfox.org/development). It will explain how the source-code is organised, and how _packages_ — the fundamental module unit of Patchfox — work.
+Your first stop is the [development documentation](https://patchfox.org/index.html#/development). It will explain how the source code is organised, and how _packages_ — the fundamental module unit of Patchfox — work.
 
 The [issue tracker](https://github.com/soapdog/patchfox/issues) lists all fixes and enhancements that are currently on track. Feel free to browse them and reach out if you'd like to help with any specific issue. Also, don't be discouraged from playing with the code and working on something that is not on the issue list. 
 

README.md

@@ -1,42 +1,40 @@
 # Patchfox
-This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension. This is a new client for [Secure Scuttlebutt](http://scuttlebutt.nz) packaged as a Web Extension for Firefox. It is available on:
 
-* [Firefox Add-ons Portal](https://addons.mozilla.org/en-US/firefox/addon/patchfox/)
-* [Chrome Web Store](https://chrome.google.com/webstore/detail/patchfox/ocanekmedfooidiahhelofknmpobdmdp?hl=en-GB&authuser=0)
+[![Build/release](https://github.com/soapdog/patchfox/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/soapdog/patchfox/actions/workflows/build.yml)
 
-So if you just want to run it, that's the easiest way. Read on if you want to develop with it. Read on if you want to develop with it.
+This is a client for [Secure Scuttlebutt](http://scuttlebutt.nz). It is available on:
 
-## Requirements
+* [Patchfox website](https://patchfox.org)
+* [Github release pages](https://github.com/soapdog/patchfox/releases)
 
-* [Firefox Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) or [Firefox Nightly](https://www.mozilla.org/en-US/firefox/nightly/) (needed so that you can sideload unsigned add-ons)
-* [Scuttle Shell](https://github.com/ssbc/scuttle-shell). This is a soft requirement. You can use your own _sbot_ or even have another client such as [Patchwork](http://github.com/ssbc/patchwork) or [Patchbay](http://github.com/ssbc/patchbay) running and providing a running _sbot_. 
+## Patchfox has a rich set of documentation
 
+Head over to the [Patchfox website](https://patchfox.org) for the documentation. 
+
+## Requirements for development
+
+* [NodeJS](https://nodejs.org)
 
 ## Setup & Building
 
-Patchfox uses [Svelte](https://svelte.technology) and requires [NodeJS](https://nodejs.org) for development. After you have NodeJS installed, you can install the dependencies with:
+Patchfox uses [Mithril](https://mithril.js.org), [Electron](https://electronjs.org) and requires [NodeJS](https://nodejs.org) for development. After you have NodeJS installed, you can install the dependencies with:
 
 ```
 $ npm install
 ```
 
-And build the add-on with:
+And run a development version of the app using:
 
 ```
-$ npm run clean-build
+$ npm run start
 ```
 
-If you use:
+To build use:
 
 ```
-$ npm run clean-dev
+$ npm run build
 ```
 
-It will build the add-on using sourcemaps which makes debugging easier but can't be submit to AMO because they limit bundles to 4mb.
-
-## Running
-
-Go to [about:debugging](about:debugging) on Firefox, select `this firefox` and click to add a temporary add-on. Select the `manifest.json` file from the `dist/` folder from this repository.
 
 ## Setup inside Patchfox
 
@@ -54,9 +52,6 @@ After installing and configuring patchfox, try browsing to:
 
 If you're interested in learning more about the technologies behind this add-on, check out:
 
-* [MDN Web Docs - WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/).
-* [Native Messaging API](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging)
-* [Native Messaging setup](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging#Setup)
 * [Secure Scuttlebutt Protocol Guide](https://ssbc.github.io/scuttlebutt-protocol-guide/)
 
 Don't hesitate to reach out to me at:
@@ -69,11 +64,9 @@ Don't hesitate to reach out to me at:
 
 Do you want a decentralized internet too? Are you worried about the loss of net neutrality and realized that radical decentralization is the way to fight back? If you want to make a financial contribution to help me fund development of this and other dex focused software, I would love to receive contributions through these channels:
 
-
 * [Buy Me A Coffee (preferred)](https://ko-fi.com/andreshouldbewriting)
 * [Patchfox Open Collective](https://opencollective.com/patchfox)
 
-
 # Artwork attribution
 
 Patchfox is using artwork by many artists including:
@@ -84,12 +77,6 @@ Patchfox is using artwork by many artists including:
 
 * Artwork for the 2020.2.1 release poster was done by: Photo by Krista Stucchio on Unsplash
 
-# Third party vendored libraries
-
-* Keymage 1.1.3: http://github.com/piranha/keymage
-* ssb-custom-uri: https://git.sr.ht/~soapdog/ssb-custom-uri
-* browser-polyfill: https://github.com/mozilla/webextension-polyfill
-
 # Dependencies Licenses
 
 Check [licenses.html](licenses.html)