add readme

2021-07-31 22:53:30 -04:00 · 2021-07-31 22:53:30 -04:00 · 746b6df6e1
commit 746b6df6e1
parent 7c6e2ba196
1 changed files with 24 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,24 @@
+README
+======
+
+Installing
+----------
+
+Clone repo:
+
+```sh
+ $ git clone https://git.rzen.dev/rzen/terminal-joke-dashboard.git
+```
+
+Run:
+
+```sh
+ $ ./run.sh
+```
+
+To exit simply press `Control-C`.
+
+Customizing
+-----------
+
+Tweak `dash.sh`.