Browse files

describe installation and usage in README

  • Loading branch information...
1 parent 04769ac commit de636472b5bfb4c80fad18168dc6b6d03fea749a @pavel-paulau committed Sep 27, 2012
Showing with 16 additions and 3 deletions.
  1. +16 −3 README.md
View
19 README.md
@@ -1,4 +1,17 @@
-btrc
-====
+Prerequisites
+-------------
-Couchbase view btree stats collector
+* Python 2.6
+* pip
+
+Installation
+-------------
+
+ pip install btrc
+
+Usage
+-------------
+
+Once you have pointed btrc to node it will collect view btree stats from all nodes in cluster and all design docs for specified bucket.
+
+ btrc -n 127.0.0.1:8091 -b default

0 comments on commit de63647

Please sign in to comment.