README: add simple readme

Signed-off-by: Sean Cross <sean@xobs.io>
2021-05-17 13:24:45 +08:00
parent 9b40e0dddf
commit 377e3a2584
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,9 @@
+# Malarkey
+
+Launch Larksuite during office hours, and terminate it outside of office hours.
+
+## Usage
+
+To run, install [Rust](https://rustup.rs/) and compile with `cargo build --release`.
+
+Working hours are currently defined as 9am - 6pm Monday through Friday, except public holidays.