summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <yuv.adm@gmail.com>2013-11-29 14:52:41 +0200
committerYuval Adam <yuv.adm@gmail.com>2013-11-29 14:52:41 +0200
commitbfb276522e4c48b8c564938d248d7260a3c75acb (patch)
tree0d76cca79dd1f7474beb80be2ea287aacdddbd1c /README.md
parent75f92c141b1fffa84d72f9c37b5083a99e2ca51f (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index b5a8f19..addfedf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
# Kismet GPS Tools
-A toolset for manipulating geographic results from Kismet.
+A collection of post-processing tools for Kismet GPS files.
+
+Currently only supports .netxml input files, and outputs Shapefiles. KML, and other formats, will be supported later on.
+
+Runs on Python 2.x as well as 3.x, and requires the `pyshp` library (installable from `requirements.txt`).
+
+## Usage
+
+```bash
+$ ./kismet-gps.tools.py -i path-to-your-input.netxml -f shapefile
+```