new

1 files changed, 49 insertions, 40 deletions

diff --git a/README.md b/README.md
index d21326f0c4..4fa4eced89 100755
--- a/README.md
+++ b/README.md
@@ -3,13 +3,44 @@ netdata
 
 linux real time system monitoring
 
-This program is a daemon that collects system information from /proc and other sources.
-It is heavily optimized and lightweight.
+This program is a daemon that collects system information from a linux system and presents a web site to view the data.
+This presentation is full of charts that precisely render all system values, in realtime, for a short time (1 hour by default).
 
-It updates everything every second!
-But tt only needs a few microseconds (just a fraction of a millisecond) of one of your cores and a few megabytes of memory.
+# Features
+
+- highly optimized C code
+  it only needs a few milliseconds per second to collect all the data.
+ 
+- extremely lightweight
+  it only needs a few megabytes of memory to store all its round robin database.
+
+- per second data collection
+  every chart, every value, is updated every second.
+
+- visualizes QoS classes automatically
+  if you also use fireqos for QoS, it even collects class names automatically.
+
+- the generated web site uses bootstrap and google charts for a very appealing result
+  it works even on mobile devices, adapts to screen size changes and rotation.
+
+- web charts do respect your browser resources
+  the charts adapt to show only as many points are required to have a clear view.
+
+- highly configurable
+  all charts and all features can be enabled or disabled.
+
+- it reads and renders charts for all these:
+ - /proc/net/dev (all netwrok interfaces for all their values)
+ - /proc/diskstats (all disks for all their values)
+ - /proc/net/snmp (total IPv4, TCP and UDP usage)
+ - /proc/net/netstat (more IPv4 usage)
+ - /proc/net/stat/nf_conntrack (connection tracking performance)
+ - /proc/net/ip_vs/stats (IPVS connection statistics)
+ - /proc/stat (CPU utilization)
+ - /proc/meminfo (memory information)
+ - /proc/vmstat (system performance)
+ - tc classes (QoS classes)
 
-If listens on port 19999 and it will give you a full featured web interface using google charts.
 
 Check it live at:
 
@@ -19,6 +50,7 @@ Here is a screenshot:
 
 ![image](https://cloud.githubusercontent.com/assets/2662304/2593406/3c797e88-ba80-11e3-8ec7-c10174d59ad6.png)
 
+
 # How it works
 
 1. You run a daemon on your linux: netdata.
@@ -39,7 +71,7 @@ Here is a screenshot:
  The above is equivalent to:
  
  ```
- http://127.0.0.1:19999/data/net.eth0/3600/1/average
+ http://127.0.0.1:19999/data/net.eth0/3600/1/average/0/0
  ```
  
  where:
@@ -47,6 +79,7 @@ Here is a screenshot:
   - 3600 is the number of entries to generate (3600 is a default which can be overwritten by -l).
   - 1 is grouping count, 1 = every single entry, 2 = half the entries, 3 = one every 3 entries, etc
   - `average` is the grouping method. It can also be `max`.
+  - 0/0 they are `before` and `after` timestamps, allowing panning on the data
 
 
 2. On your web page, you add a few javascript lines and a DIV for every graph you need.
@@ -60,49 +93,25 @@ Here is a screenshot:
 
 ## Automatic installation
 
-1. Download the git.
-2. cd to that directory
-3. run:
+Before you start, make sure you have `zlib` development files installed.
+To install it in Ubuntu, you need to run:
 
 ```sh
-./netdata.start
+apt-get install zlib1g-dev
 ```
 
-Once you run it, the file netdata.conf will be created. You can edit this file to set options for each graph.
-To apply the changes you made, you have to run netdata.start again.
-
-To access the web site for all graphs, go to:
-
- ```
- http://127.0.0.1:19999/
- ```
-
-
-
----
-
-## Installation by hand
-
-### Compile netdata
-step into the directory you downloaded everything and compile netdata
+Then do this to install and run netdata:
 
 ```sh
-gcc -Wall -O3 -o netdata netdata.c -lpthread -lz
+git clone https://github.com/ktsaou/netdata.git netdata
+cd netdata
+./netdata.start
 ```
 
-### run netdata
-Run netdata:
-
-```sh
-./netdata -u nobody -d -l 1200 -u 1 -p 19999
-```
- - -d says to go daemon mode
- - -l 1200 says to keep 1200 history entries (20 minutes)
- - -t 1 says to add a new history entry every second
- - -p 19999 is the port to listen for web clients
- - -u nobody to run as nobody
+Once you run it, the file netdata.conf will be created. You can edit this file to set options for each graph.
+To apply the changes you made, you have to run netdata.start again.
 
-### open a web browser
+To access the web site for all graphs, go to:
 
  ```
  http://127.0.0.1:19999/