summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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
+```