From 0f6374ed6f667f01b7f12b230b714ef6c5223c1a Mon Sep 17 00:00:00 2001
From: Umayr Shahid <umayr.shahid@gmail.com>
Date: Wed, 2 Oct 2019 09:08:53 -0400
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..935f272
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# `insights`
+> process exported whatsapp chat and generates insights.
+
+# Usage
+
+You need to have rust and cargo set up on your machine as it's not published anywhere
+
+```b
+λ git clone github.com/umayr/insights-rs
+λ cd insights-rs
+ 
+λ cargo build --release
+
+λ # in case you find it interesting enough
+λ mv target/release/insights /usr/local/bin
+```
+
+Once you have that out of the way, you can use it like:
+```
+λ insights -h
+
+Insights - A minimalistic whatsapp chat analyser.
+
+Usage:
+    insights <file> [--pretty] [--timeline=<duration>]
+    insights (-h | --help)
+    insights --version
+
+Options:
+    -h --help                   shows this usage
+    --version                   shows the version of application
+    --pretty                    prints the analysis in pretty format
+    --timeline=<duration>       sets the duration of the timeline [default: monthly]
+                                options:
+                                    - daily
+                                    - weekly
+                                    - monthly
+                                    - yearly
+
+λ insights path/to/exported/chat/file.txt
+# [...]
+```
+