summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <yuv.adm@gmail.com>2013-11-29 15:57:17 +0200
committerYuval Adam <yuv.adm@gmail.com>2013-11-29 15:57:17 +0200
commit2c00ee83b3453745839313d70d0f21dcad8dc228 (patch)
tree604c1da63885f0b1df8a6803df5b2146d6312fe4 /README.md
parent9a728cc507ef949ef99052756e99d72951936230 (diff)
Package v0.1.1v0.1.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index addfedf..b775ad7 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,16 @@ Currently only supports .netxml input files, and outputs Shapefiles. KML, and ot
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
```
+
+The program will save by default the shapefiles to `shapefiles/networks.*`.
+
+
+## Credits and License
+
+Copyright © 2013 Yuval Adam. This software is free for usage under the GPLv3 license.