update a few notes on installing and dependencies
@@ -33,16 +33,25 @@ vent
overview
====
-vent is a library that includes a CLI designed to serve as a general platform for analyzing network traffic. built with some basic functionality, vent serves as a user-friendly slate to build custom `plugins` on to perform user-defined processing on incoming network data. vent supports any filetype, but only processes ones based on the types of plugins installed for that instance of vent.
+vent is a library that includes a CLI designed to serve as a general platform for analyzing network traffic. built with some basic functionality, vent serves as a user-friendly platform to build custom `plugins` on to perform user-defined processing on incoming network data. vent supports any filetype, but only processes ones based on the types of plugins installed for that instance of vent.
simply create your `plugins`, point vent to them & install them, and drop a file in vent to begin processing!
+### dependencies
+
+```
+docker>=1.13.1
+make
+pip
+python2.7.x
+```
+
### getting the bits and building
```
git clone --recursive https://github.com/CyberReboot/vent.git
cd vent
-make
+make # (sudo may be required to install the vent command in the system bin path)
```
_Note - If you already have `docker-py` installed on your machine, you may need to_ `pip uninstall docker-py` _first. `vent` will install `docker-py` as part of the installation process, however there are known incompatibilities of `docker-py` with older versions._
