Merge pull request #4 from Inventitech/macos

Readme improvements

Author: Inventitech

README.md

@@ -2,6 +2,10 @@ strans
 ======
 
 [![Build Status](https://travis-ci.com/Inventitech/strans.svg?token=1pPnTvKwseJq7cTLeeFE&branch=master)](https://travis-ci.com/Inventitech/strans)
+![LOC](https://tokei.rs/b1/github/inventitech/strans)
+[![Github Releases](https://img.shields.io/github/downloads/inventitech/strans/total.svg)](https://github.com/Inventitech/strans/releases)
+[![Join the chat at https://gitter.im/inventitech/strans](https://badges.gitter.im/inventitech/strans.svg)](https://gitter.im/inventitech/strans?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 
 `strans` (string transform) is an intuitive string manipulation
 utility for the shell (primarily Unix, but should work™
@@ -13,22 +17,35 @@ apply them to the input given on STDIN.
 How to Install
 ==============
 
-The easiest way to run `strans` is by installing it via flatpak. It 
-assumes that you have the 
+`strans` is distributed as an AppImage for Linux and as a DMG for MacOs.
+Download the latest `strans` from
+[releases](https://github.com/Inventitech/strans/releases).
+
+## Linux
+Our AppImage should run on practically any recent linux Desktop distribution.
+
+After downloading, simply do
 
-`flatpak install flathub org.freedesktop.Platform//18.08 org.freedesktop.Sdk//18.08`
+`
+chmod +x strans-linux.AppImage
+./strans-linux.AppImage
+`
 
-runtime installed on your system.
+To install it system-wide as `strans`, just
 
-After downloading the latest `strans.flatpak` from
-[releases](https://github.com/Inventitech/strans/releases), install it
-via
+`sudo cp strans-linux.AppImage /usr/bin/strans`
 
-`sudo flatpak install strans.flatpak`
+## MacOs
+After mounting the `dmg` and copying `strans.app` into `/Applications`, it might be necessary to
 
-> Note: This standalone Flatpak package will not auto-update. 
+```
+chmod +x /Applications/strans.app/Contents/MacOS/strans
+/Applications/strans.app/Contents/MacOS/strans
+```
+to run `strans`.
+ 
 
-How to Run
+How to Use
 ==========
 ```
 # With before and after example
@@ -77,7 +94,7 @@ without StackOverflow and Perl, but instead with pure joy!
 
 ```
 printf "Moritz Beller\nGeorgios Gousios" |
-dotnet strans.dll -b "First Last" -a "FL"
+strans -b "First Last" -a "FL"
 ```
 
 neatly outputs
@@ -109,7 +126,7 @@ and call
 
 ```
 printf "Moritz Beller\nGeorgios Gousios\nAndy Emil Zaidman" |
-dotnet strans.dll --example-file example-transformations
+strans --example-file example-transformations
 ```
 
 And, voila, the output is
@@ -125,8 +142,8 @@ transformation rule that satisfies all examples given to it. Simply
 having the last FML example would not be enough, because it would miss
 the case where only two names are available.
 
-How to Build for Developing
-===========================
+How to Develop
+==============
 
 You need [dotnet](https://dotnet.microsoft.com/) to run `strans`.
 
@@ -137,7 +154,7 @@ dotnet restore
 dotnet publish -c Release
 ```
 
-An alias (in your bashrc, ...) makes `strans` integrate seamlessly in
+An alias (in your bashrc, ...) can make `strans` integrate seamlessly in
 a Unix environment:
 
 ```