update README

README.md

@@ -1,13 +1,12 @@
 ![malice logo](https://raw.githubusercontent.com/maliceio/malice/master/docs/images/logo/malice.png)
 
-malice
-======
+# malice
 
 [![Release](https://img.shields.io/github/release/maliceio/malice.svg)](https://github.com/gmaliceio/malice/releases/latest) [![License](https://img.shields.io/badge/licence-Apache%202.0-blue.svg)](LICENSE) [![Build Status](https://travis-ci.org/maliceio/malice.svg?branch=master)](https://travis-ci.org/maliceio/malice) [![GoDoc](https://godoc.org/github.com/maliceio/malice?status.svg)](https://godoc.org/github.com/maliceio/malice) [![codecov](https://codecov.io/gh/maliceio/malice/branch/master/graph/badge.svg)](https://codecov.io/gh/maliceio/malice) [![Gitter](https://badges.gitter.im/maliceio/malice.svg)](https://gitter.im/maliceio/malice)
 
 Malice's mission is to be a free open source version of VirusTotal that anyone can use at any scale from an independent researcher to a fortune 500 company.
 
-### Setup Docker (OSX)
+## Setup Docker (OSX)
 
 Install [Docker for Mac](https://docs.docker.com/docker-for-mac/)
 
@@ -24,9 +23,9 @@ $ docker-machine create --driver virtualbox --engine-storage-driver overlay mali
 $ eval $(docker-machine env malice)
 ```
 
-### Getting Started (OSX)
+## Getting Started (OSX)
 
-#### Install
+### Install
 
 ```bash
 $ brew install maliceio/tap/malice
@@ -43,22 +42,22 @@ Author:
   blacktop - <https://github.com/blacktop>
 
 Options:
-  --debug, -D  	Enable debug mode [$MALICE_DEBUG]
-  --help, -h   	show help
-  --version, -v	print the version
+  --debug, -D      Enable debug mode [$MALICE_DEBUG]
+  --help, -h       show help
+  --version, -v    print the version
 
 Commands:
-  scan		Scan a file
-  watch		Watch a folder
-  lookup	Look up a file hash
-  elk		Start an ELK docker container
-  plugin	List, Install or Remove Plugins
-  help		Shows a list of commands or help for one command
+  scan        Scan a file
+  watch        Watch a folder
+  lookup    Look up a file hash
+  elk        Start an ELK docker container
+  plugin    List, Install or Remove Plugins
+  help        Shows a list of commands or help for one command
 
 Run 'malice COMMAND --help' for more information on a command.
 ```
 
-#### Scan some *malware*
+### Scan some _malware_
 
 ```bash
 $ malice scan evil.malware
@@ -68,33 +67,33 @@ $ malice scan evil.malware
 
 Malice will output the results as a markdown table that can be piped or copied into a **results.md** that will look great on Github see [here](docs/examples/scan.md)
 
-#### Start Malice's Web UI
+### Start Malice's Web UI
 
 ```bash
 $ malice elk
 ```
 
-> You can open the [Kibana](https://www.elastic.co/products/kibana) UI and look at the scan results here: [http://localhost](http://localhost) (*assuming you are using Docker for Mac*\)
+> You can open the [Kibana](https://www.elastic.co/products/kibana) UI and look at the scan results here: <http://localhost> (_assuming you are using Docker for Mac_)
 
 ![kibana-setup](docs/images/kibana-setup.png)
 
--	Type in **malice** as the `Index name or pattern` and click **Create**.
+- Type in **malice** as the `Index name or pattern` and click **Create**.
 
--	Now click on the `Discover Tab` and **behold!!!**
+- Now click on the `Discover Tab` and **behold!!!**
 
 ![kibana-scan](docs/images/kibana-scan.png)
 
-### Getting Started (*Docker in Docker*\)
+## Getting Started (_Docker in Docker_) :construction: :warning: **[currently broken]**
 
 [![CircleCI](https://circleci.com/gh/maliceio/malice.png?style=shield)](https://circleci.com/gh/maliceio/malice) [![Docker Stars](https://img.shields.io/docker/stars/malice/engine.svg)](https://hub.docker.com/r/malice/engine/) [![Docker Pulls](https://img.shields.io/docker/pulls/malice/engine.svg)](https://hub.docker.com/r/malice/engine/) [![Docker Image](https://img.shields.io/badge/docker%20image-30.6%20MB-blue.svg)](https://hub.docker.com/r/malice/engine/)
 
-#### Install/Update all Plugins
+### Install/Update all Plugins
 
 ```bash
 docker run --rm -v /var/run/docker.sock:/var/run/docker.sock malice/engine plugin update --all
 ```
 
-#### Scan a file
+### Scan a file
 
 ```bash
 docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \
@@ -103,14 +102,13 @@ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \
                 malice/engine scan SAMPLE
 ```
 
-Documentation
--------------
+## Documentation
 
--	[Documentation](docs)
--	[Plugins](docs/plugins)
--	[Examples](docs/examples)
--	[Roadmap](docs/roadmap)
--	[Contributing](CONTRIBUTING.md)
+- [Documentation](docs)
+- [Plugins](docs/plugins)
+- [Examples](docs/examples)
+- [Roadmap](docs/roadmap)
+- [Contributing](CONTRIBUTING.md)
 
 ### Known Issues :warning:
 
@@ -120,7 +118,7 @@ I have noticed when running the new **5.0+** version of [malice/elasticsearch](h
 sudo sysctl -w vm.max_map_count=262144
 ```
 
-Elasticsearch requires at least **4GB** of RAM to run. You can lower it to **2GB** by running the following *\(**before running a scan**\)*:
+Elasticsearch requires at least **4GB** of RAM to run. You can lower it to **2GB** by running the following _(**before running a scan**)_:
 
 ```bash
 $ docker run -d \
@@ -140,5 +138,5 @@ See [`CHANGELOG.md`](https://github.com/maliceio/malice/blob/master/CHANGELOG.md
 
 ### License
 
-Apache License (Version 2.0)  
+Apache License (Version 2.0)<br>
 Copyright (c) 2013 - 2017 **blacktop** Joshua Maine