summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 97c3568..8bf622d 100644
--- a/README.rst
+++ b/README.rst
@@ -5,6 +5,15 @@
**ngxtop** parses your nginx access log and outputs useful, ``top``-like, metrics of your nginx server.
So you can tell what is happening with your server in real-time.
+Installation
+------------
+
+::
+
+ pip install ngxtop
+
+
+Note: ``ngxtop`` is primarily developed and tested with python2 but also supports python3.
Usage
-----