add readme

1 files changed, 22 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..ed9568c
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,22 @@
+prompt
+------
+
+fast prompt helper tool to fetch vcs & cwd information, for
+use with tmux:
+
+
+   set -g  status-left "#(prompt cwd #{pane_current_path})"
+   set -ag status-left "#(prompt vcs #{pane_current_path})"
+
+
+usage
+-----
+
+    prompt cwd <some_path>
+          Compresses some_path and stripes $HOME from its
+          prefix
+
+    prompt vcs <some_path>
+          Fetches git ref (branch shorthand/commit OID),
+          repo file statuses and commit distance
+          information