summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88b70b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+
+gstatsd - A statsd service implementation in Python + gevent.
+
+License: Apache 2.0
+
+Usage:
+------
+
+Show gstatsd help:
+
+ % gstatsd -h
+
+Start gstatsd and send stats to port 9100 every 5 seconds:
+
+ % gstatsd -d :9100 -f 5
+
+Bind listener to host 'hostname' port 8126:
+
+ % gstatsd -b hostname:8126 -d :9100 -f 5
+