expand readme and show usage instructions

Signed-off-by: Daniel Stamer <[email protected]>

Author: helloworlddan

README.md

@@ -1,11 +1,11 @@
 # icecli
-
-## Installation
-Grab the appropriate archive from the releases section of this repo, extract it, move the included binary somewhere on your $PATH and make it executable.
+icecli is a tool to query on-train ICE API endpoints for real-time information about train and journey.
 
 ## Usage
 In order to use the tool you have to be on a German ICE train and connected to the onboard WiFi SSID `WIFIonICE`.
 
+![Usage of the tool](assets/icecli.gif)
+
 ```bash
 # Get help
 $ icecli --help
@@ -28,3 +28,5 @@ $ icecli trip -d "Berlin Hbf (tief)" -o csv
 # Change output format to CSV and filter for only ETA to your destination override
 $ icecli trip -d "Berlin Hbf (tief)" -o csv -f "ARRIVING"
 ```
+## Installation
+Grab the appropriate archive from the releases section of this repo, extract it, move the included binary somewhere on your $PATH and make it executable.

assets/icecli.gif

@@ -0,0 +1,66 @@
+# VHS documentation
+#
+# Output:
+#   Output <path>.gif               Create a GIF output at the given <path>
+#   Output <path>.mp4               Create an MP4 output at the given <path>
+#   Output <path>.webm              Create a WebM output at the given <path>
+#
+# Settings:
+#   Set FontSize <number>           Set the font size of the terminal
+#   Set FontFamily <string>         Set the font family of the terminal
+#   Set Height <number>             Set the height of the terminal
+#   Set Width <number>              Set the width of the terminal
+#   Set LetterSpacing <float>       Set the font letter spacing (tracking)
+#   Set LineHeight <float>          Set the font line height
+#   Set Theme <string>              Set the theme of the terminal (JSON)
+#   Set Padding <number>            Set the padding of the terminal
+#   Set Framerate <number>          Set the framerate of the recording
+#   Set PlaybackSpeed <float>       Set the playback speed of the recording
+#
+# Sleep:
+#   Sleep <time>                    Sleep for a set amount of <time> in seconds
+#
+# Type:
+#   Type[@<time>] "<characters>"    Type <characters> into the terminal with a
+#                                   <time> delay between each character
+#
+# Keys:
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Down[@<time>] [number]          Press the Down key
+#   Enter[@<time>] [number]         Press the Enter key
+#   Space[@<time>] [number]         Press the Space key
+#   Tab[@<time>] [number]           Press the Tab key
+#   Left[@<time>] [number]          Press the Left Arrow key
+#   Right[@<time>] [number]         Press the Right Arrow key
+#   Up[@<time>] [number]            Press the Up Arrow key
+#   Down[@<time>] [number]          Press the Down Arrow key
+#   Ctrl+<key>                      Press the Control key + <key> (e.g. Ctrl+C)
+#
+# Display:
+#   Hide                            Hide the subsequent commands from the output
+#   Show                            Show the subsequent commands in the output
+
+Output icecli.gif
+
+Set FontSize 14
+Set Width 1200
+Set Height 600
+
+Type "icecli"  Sleep 500ms  Enter
+Sleep 5s
+
+Type "clear" Sleep 100ms Enter
+Type "icecli status"  Sleep 500ms  Enter
+Sleep 3s
+
+Type "clear" Sleep 100ms Enter
+Type "icecli trip"  Sleep 500ms  Enter
+Sleep 3s
+
+Type "clear" Sleep 100ms Enter
+Type "icecli trip stops"  Sleep 500ms  Enter
+Sleep 5s
+
+Type "clear" Sleep 100ms Enter
+Type "icecli trip stops -d 'Frankfurt(Main)Hbf'"  Sleep 500ms  Enter
+Sleep 5s