updated

README.md

@@ -1,2 +1,63 @@
-# Fake-Apache-Log-Generator
+# Fake Apache Log Generator
-Generate a boatload of Fake Apache Log files very quickly
+
+This script generates a boatload of fake apache logs very quickly. Its useful for generating fake workloads for [data ingest](http://github.com/streamsets/datacollector) and/or analytics applications.
+
+It can write log lines to console, to log files or directly to gzip files.
+
+It utilizes the excellent [Faker](https://github.com/joke2k/faker/) library to generate realistic ip's, URI's etc.
+
+***
+
+## Basic Usage
+
+Generate a single log line to STDOUT
+```
+$ python apache-fake-log-gen.py  
+```
+
+Generate 100 log lines into a .log file
+```
+$ python apache-fake-log-gen.py -n 100 -o LOG 
+```
+
+Generate 100 log lines into a .gz file
+```
+$ python apache-fake-log-gen.py -n 100 -o GZ 
+```
+
+Infinite log file generation (useful for testing File Tail Readers)
+```
+$ python apache-fake-log-gen.py -n 0 -o LOG 
+```
+
+Prefix the output filename 
+```
+$ python apache-fake-log-gen.py -n 100 -o LOG -p WEB1
+```
+
+
+Detailed help
+```
+$ python apache-fake-log-gen.py -h
+usage: apache-fake-log-gen.py [-h] [--output {LOG,GZ,CONSOLE}]
+                              [--num NUM_LINES] [--prefix FILE_PREFIX]
+
+Fake Apache Log Generator
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --output {LOG,GZ,CONSOLE}, -o {LOG,GZ,CONSOLE}
+                        Write to a Log file, a gzip file or to STDOUT
+  --num NUM_LINES, -n NUM_LINES
+                        Number of lines to generate (0 for infinite)
+  --prefix FILE_PREFIX, -p FILE_PREFIX
+                        Prefix the output file name
+```
+
+
+## Requirements
+* Python 2.7
+* ```pip install fake-factory numpy ```
+
+## License
+This script is released under the [Apache version 2](LICENSE) license.