Tidy README.md to follow Markdown rules provided by markdownlint
-vent
-====
+
+# vent
> Network Visibility (an anagram)
@@ -12,15 +12,15 @@ vent
![Vent Logo](/docs/img/vent-logo.png)
-overview
-====
+## 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 platform to build custom `plugins` that perform user-defined processing on incoming network data. vent is filetype-agnostic in that the plugins installed within your specific vent instance determine what type of files your instance supports.
Simply create your `plugins`, point vent to them & install them, and drop a file in vent to begin processing!
-### dependencies
+## Dependencies
-```
+``` bash
docker>=1.13.1
git
make (if building from source)
@@ -28,44 +28,46 @@ pip3
python3.6.x
```
-### option 1: running inside of a Docker container
+## Installation
-```
+### Option 1: Running inside of a Docker container
+
+``` bash
docker run -it -v /var/run/docker.sock:/var/run/docker.sock cyberreboot/vent
```
-### option 2: installing
+### Option 2: Installing directly
-```
+``` bash
pip3 install vent
```
-### option 3: getting the bits and building
+### Option 3: Getting the source and building
-```
+``` bash
git clone https://github.com/CyberReboot/vent.git
cd vent
```
Root/sudo users can simply run `make` to compile and install the platform. Users with limited permissions or require user-local installation can use the following:
-```
+``` bash
sudo env "PATH=$PATH" make
```
_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._
-### running
+## Running
-```
+``` bash
vent
```
-documentation
-====
+
+## Documentation
+
Want to read the documentation for vent? Great! You can find it [here](https://vent.readthedocs.io/en/latest/?badge=latest)
-contributing to vent
-====
+## Contributing to vent
Want to contribute? Awesome! Issue a pull request or see more details [here](https://github.com/CyberReboot/vent/blob/master/CONTRIBUTING.md).
