From 0a14b364fac4289f152f9f674012f7fafb282ddf Mon Sep 17 00:00:00 2001
From: Ultrabug <ultrabug@gentoo.org>
Date: Tue, 19 Feb 2013 17:31:00 +0100
Subject: first README commit

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 60dce6d..5785031 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,18 @@
 py3status
 =========
 
-py3status wraps the mighty i3status for enhanced i3bar customization on i3wm
\ No newline at end of file
+py3status extends the mighty i3status for enhanced i3bar customization on i3wm
+
+# Start using it
+In your i3 config file, simply change the `status_command` with:
+    status_command py3status
+
+That's it !
+
+# Useful options
+You can see the help of py3status by issuing `py3status -h`
+
+  -c I3STATUS_CONF  path to i3status config file
+  -n INTERVAL       polling interval in seconds (default 1 sec)
+  -i INCLUDE_PATH   user-based class include directory
+  -d                disable integrated transformations
-- 
cgit v1.3