readme ++

Enteee · Feb 3, 2017 · b5d1d1d · b5d1d1d
1 parent 6c21fe2
commit b5d1d1d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-# pdml2flow-elasticsearch-elasticsearch [![PyPI version](https://badge.fury.io/py/pdml2flow-elasticsearch.svg)](https://badge.fury.io/py/pdml2flow-elasticsearch) 
-_Aggregates wireshark pdml to flows_
+# pdml2flow-elasticsearch [![PyPI version](https://badge.fury.io/py/pdml2flow-elasticsearch.svg)](https://badge.fury.io/py/pdml2flow-elasticsearch) 
+_Saves [pdml2flow] output in elasticsearch_
 
 | Branch  | Build  | Coverage |
 | ------- | ------ | -------- |
 | master  | [![Build Status master]](https://travis-ci.org/Enteee/pdml2flow-elasticsearch) | [![Coverage Status master]](https://coveralls.io/github/Enteee/pdml2flow-elasticsearch?branch=master) |
 | develop  | [![Build Status develop]](https://travis-ci.org/Enteee/pdml2flow-elasticsearch) | [![Coverage Status develop]](https://coveralls.io/github/Enteee/pdml2flow-elasticsearch?branch=develop) |
 
 ## Prerequisites
+
+* [pdml2flow]
 * [python]:
   - 3.4
   - 3.5
@@ -21,7 +23,6 @@ _Aggregates wireshark pdml to flows_
 
 ## Configuration
 
-ES_HOST
 | Environment variable | Description |
 | ------- | ------ |
 | ES_HOST | Elasticsearch hostname|
@@ -32,11 +33,9 @@ ES_HOST
 
 ## Example
 
+[pdml2flow]: https://github.com/Enteee/pdml2flow
 [python]: https://www.python.org/
 [wireshark]: https://www.wireshark.org/
-[dict2xml]: https://github.com/delfick/python-dict2xml
-[jq]: https://stedolan.github.io/jq/
-[FluentFlow]: https://github.com/t-moe/FluentFlow
 
 [Build Status master]: https://travis-ci.org/Enteee/pdml2flow-elasticsearch.svg?branch=master
 [Coverage Status master]: https://coveralls.io/repos/github/Enteee/pdml2flow-elasticsearch/badge.svg?branch=master

diff --git a/scripts/mkreadme.sh b/scripts/mkreadme.sh
@@ -2,7 +2,7 @@
 TOPLEVEL=$(git rev-parse --show-toplevel)
 
 cat <<EOF > "${TOPLEVEL}/README.md"
-# pdml2flow-elasticsearch-elasticsearch [![PyPI version](https://badge.fury.io/py/pdml2flow-elasticsearch.svg)](https://badge.fury.io/py/pdml2flow-elasticsearch) 
+# pdml2flow-elasticsearch [![PyPI version](https://badge.fury.io/py/pdml2flow-elasticsearch.svg)](https://badge.fury.io/py/pdml2flow-elasticsearch) 
 _Saves [pdml2flow] output in elasticsearch_
 
 | Branch  | Build  | Coverage |