Add usage instructions

oz · Feb 6, 2021 · 43f23fb · 43f23fb
1 parent 7782dab
commit 43f23fb
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,23 @@
 tz helps you schedule things across time zones. It is an interactive TUI
 program that displays time across a few time zones of your choosing.
 
+# Installing
+
+The quickest thing is probably to grab a release, but no one will be
+harmed if you build from source.
+
+# Usage
+
+Start tz to show the local time, as well as the UTC time zone. It's
+nicer to set the `TZ_LIST` environment variable with a comma-separated
+list of [tz data][tzdata] zone names:
+
+[tzdata]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+
+<p align="center">
+<img align="center" src="./docs/demo.gif" />
+</p>
+
 # Building
 
 Clone this repository and run:

diff --git a/docs/demo.gif b/docs/demo.gif