improved documentation.

This commit is contained in:
didier.amyot committed 2014-07-03 10:15:21 -04:00
1 parent f8b5a714a1
commit 0ef496d459
8 files changed
+32 -10

No files matched your search

+31 -2
View File
@@ -7,11 +7,40 @@ project is inspired by [mongs](http://whit537.org/mongs/) but has additional fea
* View basic statistics
* Easy filtering support
### run vulture
1. Download your binaries
* [windows](https://bitbucket.org/damyot/vulture/downloads/vulture_windows_amd64.tar.gz)
* [mac](https://bitbucket.org/damyot/vulture/downloads/vulture_darwin_amd64.tar.gz)
* [linux](https://bitbucket.org/damyot/vulture/downloads/vulture_linux_amd64.tar.gz)
2. Unzip the file
3. run the `vulture` (or vulture.exe) executable.
### params
You can add mongodb servers or change the vulture listening port in the params.yml
file.
### screenshots
![general view](https://bytebucket.org/damyot/vulture/raw/default/screenshots/screenshot_1.png)
| | |
| ------------------------------ |:-----------------------------:|
| ![general view][general_view] | ![geojson view][geojson_view] |
| ![general view][general_view] | ![geojson view][geojson_view] |
![geojson view](https://bytebucket.org/damyot/vulture/raw/default/screenshots/screenshot_2.png)
[general_view]: https://bytebucket.org/damyot/vulture/raw/default/screenshots/general.png
[geojson_view]: https://bytebucket.org/damyot/vulture/raw/default/screenshots/geo.png
[stats_view]: https://bytebucket.org/damyot/vulture/raw/default/screenshots/stats.png
[key_view]: https://bytebucket.org/damyot/vulture/raw/default/screenshots/key.png