update README

gitjonez · May 29, 2022 · 489df78 · 489df78
1 parent 8b178a9
commit 489df78
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
 # timepy
 Time stuffs
+
+But seriously, print out the time in some timezones. 
+
+## Requirements
+- python 3.9-ish (likely 3.7+)
+- pytz
+
+## Running
+`python src/timepy.py`
+
+## Installation
+`cp src/timepy.py <somewhere-in-your-path>/`
+e.g. `cp src/timepy.py ~/bin/timepy`
+
+## Notes 
+### Time travel
+"time has changed" and `pytz` depricated in python 3.10  (d'oh!)