feat: cleanup readme (#34)

* feat: cleanup readme

* chore: transparent background image

* chore: better colours on the flow diagram

* chore: update image

* chore: update image

* chore: update image

* chore: update image

* chore: put image into the tl;dr section

* chore: put image into the tl;dr section

* chore: wip

* chore: wip

* chore: wip

* chore: wip

* chore: wip

* chore: wip

* chore: wip

* chore: wip

* chore: wip

Co-authored-by: Mathew Davies <thepixeldeveloper@icloud.com>

README.md

@@ -1,101 +1,29 @@
-<p align="center">
-  <a href="https://github.com/thepixeldeveloper/tunnel-boring-masshine">
-    <img src="tunnel-boring-masshine.png" alt="Logo" width="1280">
-  </a>
+<h1 align="center">Tunnel Boring MaSSHine</h1>
+<p align="center"><img src="docs/readme.png" width="100%" /></p>
+<p align="center">Access remote server software, on your computer.</p>
 
-  <h3 align="center">Tunnel Boring MaSSHine</h3>
+<p align="center">
+ Download for 
+  <a href="https://github.com/ThePixelDeveloper/tunnel-boring-masshine/releases/download/v0.1.3/tunnel-boring-masshine-0.1.3.dmg">macOS</a>,  
+  <a href="https://github.com/ThePixelDeveloper/tunnel-boring-masshine/releases/download/v0.1.3/tunnel-boring-masshine-Setup-0.1.3.exe">Windows</a> and
+  <a href="https://github.com/ThePixelDeveloper/tunnel-boring-masshine/releases/download/v0.1.3/tunnel-boring-masshine-0.1.3.AppImage">Linux</a>
 
-  <p align="center">
-    Reliable SSH tunnels from one machine to another.
-    <br />
-    <br />
-    <a href="https://github.com/thepixeldeveloper/tunnel-boring-masshine/releases"><strong>Download</strong></a>
-    ·
-    <a href="https://github.com/thepixeldeveloper/tunnel-boring-masshine/issues">Report Bug</a>
-    ·
-    <a href="https://github.com/thepixeldeveloper/tunnel-boring-masshine/issues">Request Feature</a>
-  </p>
 </p>
 
-## Table of Contents
-
-* [About the Project](#about-the-project)
-  * [Features](#features)
-  * [Built With](#built-with)
-* [Getting Started](#getting-started)
-  * [Prerequisites](#prerequisites)
-  * [Installation](#installation)
-* [Roadmap](#roadmap)
-* [Code of Conduct](#code-of-conduct)
-* [Contributing](#contributing)
-* [License](#license)
-* [Contact](#contact)
-
-## About the Project
-
-Inspired by the lack of [Core Tunnel](https://apps.apple.com/us/app/core-tunnel/id1354318707?mt=12)
-on elementaryOS, the Tunnel Boring MaSSHine is an easy way to manage SSH
-tunnels on Linux, Mac _and_ Windows. This is a minimal start, so will
-happily take on feature requests .
-
-
-### Features
-
-1. Supports local SSH tunnels (`ssh -L`)
-
-### Built With
-
-* [Electron](https://www.electronjs.org/)
-* [Electron Builder](https://www.electron.build/)
-* [Vue CLI Plugin Electron Builder](https://github.com/nklayman/vue-cli-plugin-electron-builder)
-* [Vuelidate](https://vuelidate.js.org/)
-* [SSH2](https://github.com/mscdex/ssh2)
-* [Tailwind CSS](https://tailwindcss.com/)
-
-## Getting Started
-
-To get a local copy up and running follow these simple steps.
+## Abstract
 
-### Prerequisites
+The Tunnel Boring MaSSHine makes it easy to manage your SSH tunnels.  
 
-This software was built using the following versions of node and yarn.
+No more forgetting what command line argument you need to run.  
 
-* node @ v14.9.0
-* yarn @ 1.22.5
+Go from running this:  
 
-Problems running on other versions should be raised as an [issue](https://github.com/thepixeldeveloper/tunnel-boring-masshine/issues).
-
-### Installation
-
-1. Clone the repo
-```sh
-git clone https://github.com/thepixeldeveloper/tunnel-boring-masshine.git
-```
-2. Install yarn packages
-```sh
-yarn
+``` bash
+ssh -L 127.0.0.1:4646:10.0.1.2:4646 192.168.1.1 \
+    -o ServerAliveInterval=60 \ 
+    -o ServerAliveCountMax=3 
 ```
-3. Start the development environment
-``` sh
-yarn electron:serve
-```
-
-## Roadmap
-
-See the [open issues](https://github.com/thepixeldeveloper/tunnel-boring-masshine/issues) for a list of proposed features (and known issues).
-
-## Code of Conduct
-
-See the [CODE-OF-CONDUCT.md](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
-
-## Contributing
-
-See the [CONTRIBUTING.md](CONTRIBUTING.md) guide.
-
-## License
-
-Distributed under the GPL v3 License. See [LICENSE](LICENSE) for more information.
 
-## Contact
+to having this:  
 
-* **Email**: [ThePixelDeveloper@users.noreply.github.com](mailto:ThePixelDeveloper@users.noreply.github.com)
+<img src="./docs/tray.png" width="50%">