From 208928cb65c16cc3d93a4ae28ef258ba39658b7d Mon Sep 17 00:00:00 2001
From: Abraham Toriz <categulario@gmail.com>
Date: Sun, 27 Jun 2021 23:20:37 -0500
Subject: [PATCH] add readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d2145b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Tiempo
+
+A [timetrap](https://github.com/samg/timetrap/) compatible time tracking
+command line application.
+
+## How to run
+
+You need [rust](https://rustup.rs), then clone the repo and simply run
+
+    cargo test
+
+to check that everything is working, and then
+
+    cargo build --release
+
+to have a binary at `target/release/tiempo` that you can then move to a
+directory in your `PATH`. Pro tip, alias it to `t`.
+
+Run
+
+    tiempo --help
+
+to see the options.