add README

Author: ahmedakef

README.md

@@ -0,0 +1,39 @@
+# What is summarize?
+Summarizer gives you Summary about stream of integers and it updates the summary every specified interval.
+![example.gif](example.gif)
+
+# Installation
+```bash
+curl 
+```
+# Usage
+to summarize numbers from standard input:
+```bash
+summarizer
+```
+
+to summarize numbers from file:
+```bash
+summarizer -f file_name
+```
+
+other options:
+```
+  -h [ --help ]               Produce help message
+  -f [ --file ] arg           Eead input from a file
+  -d [ --delay ] arg (=1)     Delay time between re-calculating
+  -p [ --precision ] arg (=2) Control the precision parameter
+```
+
+# Common Usage
+Usally you won't get a stream of numbers in you logs, you will need to precess the logs first to extract the numers you want only
+assume that `./generate` produce this logs:
+```
+the request took 383 seconds to complete
+the request took 886 seconds to complete
+the request took 777 seconds to complete
+```
+you can use `awk` first then pass the resut to `summarize`
+```bash
+./generator | awk -W interactive '{print $4}' | ./summarize
+```

example.gif

@@ -62,10 +62,10 @@ int main(int ac, char *av[])
     {
         po::options_description desc("Allowed options");
         desc.add_options()
-            ("help,h", "produce help message")
-            ("file,f", po::value<string>(), "read input from a file")
-            ("delay,d", po::value<int>(&delay)->default_value(1), "delay time between re-calculating")
-            ("precision,p", po::value<int>(&precision)->default_value(2), "control the precision parameter")
+            ("help,h", "Produce help message")
+            ("file,f", po::value<string>(), "Eead input from a file")
+            ("delay,d", po::value<int>(&delay)->default_value(1), "Delay time between re-calculating")
+            ("precision,p", po::value<int>(&precision)->default_value(2), "Control the precision parameter")
         ;
 
         po::positional_options_description p;
@@ -78,8 +78,8 @@ int main(int ac, char *av[])
 
         if (vm.count("help"))
         {
-            cout << "summarizer - Summarize a stream of numbers by printing some aggregation functions every specified interval\n";
-            cout << "Usage: summarizer [file_name] [options]\n";
+            cout << "summarize - Summarize a stream of numbers by printing some aggregation functions every specified interval\n";
+            cout << "Usage: summarize [file_name] [options]\n";
             cout << desc << "\n";
             return 0;
         }

main.cpp

@@ -2,6 +2,6 @@ all:
 	c++ \
 	-std=c++11 \
 	-pthread \
-	-o summarizer \
+	-o summarize \
 	main.cpp utils/utils.cpp modules/summarizer.cpp \
 	-lboost_program_options