doc: add GIF to README

Author: DanStough

README.md

@@ -4,6 +4,8 @@ _Pronounced "epic-but-with-a-k"_
 A CLI for working with Unix Timestamps inspired by [epochconverter.com](https://www.epochconverter.com).
 Also kind of like Unix `date`, but for smoother brains and folks who like nanosecond timestamps.
 
+![Terminal prompt showing generating a timestamp and parsing it with epok](./docs/assets/epok.gif)
+
 Main commands:
 1. **`parse`** - read a unix timestamp and return the human readable form. Infers the precision.
 2. **`now`** - generate a unix timestamp for the current instant. Multiple precisions supported.
@@ -57,7 +59,10 @@ go test -v ./...
 
 ## TODO
 
-### MVP
+<details>
+
+<summary>MVP</summary>
+
 * [X] `parse` command
   * [X]  Outputs UTC and local system time from arg
   * [X]  Outputs UTC and local system time from stdin
@@ -66,12 +71,14 @@ go test -v ./...
   * [X] `-p,--precision` to specify the precision
 * [X] `go install` instructions
 * [X] Version command (handled by `fang`)
-* [ ] Flair: GIF + ~Ascii Art~ + Logo
+* [X] Flair: GIF + Ascii Art
 * [X] CI
   * [X] go releaser
 * [X] homebrew tap
 
-### Part 1
+</details>
+
+### Milestone 1
 * [ ] Makefile, Taskfile or `Just` to build
 * [ ] `parse` command
   * [ ]  timezone flag for parse command to specify additional output zone
@@ -88,8 +95,7 @@ go test -v ./...
 * [X] Output Mode: `json`
 * [ ] golintci + CI
 * [ ]  `at` command for generating a unix timestamp from multiple formats.
-* [ ] Add "preferred timezones" to the config file, which are used when outputing 
-human readable information.
+* [ ] Add "preferred timezones" to the config file, which are used when outputting human-readable information.
 * [ ] batch process multiple timestamps and return tabular delta 
 * [X] ~built-in copy/paste functionality (yes, I know `pbcopy`/`pbpaste` is a thing)~ now I'm thinking this doesn't make much sense if you can read from stdin.
 * [ ] "default" command - alias your favorite command in the tool

docs/assets/epok.gif

@@ -0,0 +1,85 @@
+# 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>
+#
+# Require:
+#   Require <string>                Ensure a program is on the $PATH to proceed
+#
+# 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 LoopOffset <float>%         Set the starting frame offset for the GIF loop
+#   Set Theme <json|string>         Set the theme of the terminal
+#   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
+#   Set MarginFill <file|#000000>   Set the file or color the margin will be filled with.
+#   Set Margin <number>             Set the size of the margin. Has no effect if MarginFill isn't set.
+#   Set BorderRadius <number>       Set terminal border radius, in pixels.
+#   Set WindowBar <string>          Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
+#   Set WindowBarSize <number>      Set window bar size, in pixels. Default is 40.
+#   Set TypingSpeed <time>          Set the typing speed of the terminal. Default is 50ms.
+#
+# 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:
+#   Escape[@<time>] [number]        Press the Escape key
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Delete[@<time>] [number]        Press the Delete key
+#   Insert[@<time>] [number]        Press the Insert 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
+#   PageUp[@<time>] [number]        Press the Page Up key
+#   PageDown[@<time>] [number]      Press the Page Down 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 ./assets/epok.gif
+
+Require epok
+
+Set Shell "bash"
+Set FontSize 32
+Set Width 1600
+Set Height 800
+Set Theme { "name": "Epok", "black": "#535178", "red": "#ef6487", "green": "#5eca89", "yellow": "#fdd877", "blue": "#65aef7", "magenta": "#aa7ff0", "cyan": "#43c1be", "white": "#ffffff", "brightBlack": "#535178", "brightRed": "#ef6487", "brightGreen": "#5eca89", "brightYellow": "#fdd877", "brightBlue": "#65aef7", "brightMagenta": "#aa7ff0", "brightCyan": "#43c1be", "brightWhite": "#ffffff", "background": "#29283b", "foreground": "#b3b0d6", "selection": "#3d3c58", "FF8B00": "#FF8B00" }
+Set WindowBar Colorful
+Set Margin 20
+Set MarginFill "#FF8B00"
+Set BorderRadius 10
+Set TypingSpeed 0.150
+
+Type "# generate a unix timestamp" Sleep 1s Enter Enter
+
+Type "epok now" Sleep 1s  Enter Enter
+
+Type "# save a nanosecond timestamp to the clipboard" Sleep 1s Enter Enter
+
+Type "epok now --precision=nanos --output=simple | tee >(pbcopy)" Sleep 1s Enter Enter
+
+Type "# display the human-readable timestamp" Sleep 1s Enter Enter
+
+Type "pbpaste | epok parse" Sleep 1s Enter
+
+Sleep 10s