docs|FEAT: Add new README.md (globocom#445)

README.md

@@ -1,111 +1,87 @@
-<h1 align="center">
-  <p align="center">huskyCI - Performing security tests inside your CI</p>
-</h1>
-
 <p align="center">
   <img src="https://raw.githubusercontent.com/wiki/globocom/huskyCI/images/huskyCI-logo.png" align="center" height="" />
   <!-- logo font: Anton -->
 </p>
 
 <p align="center">
   <a href="https://github.com/globocom/huskyCI/releases"><img src="https://img.shields.io/github/v/release/globocom/huskyCI"/></a>
-  <a href="https://coveralls.io/github/globocom/huskyCI?branch=master"><img src="https://coveralls.io/repos/github/globocom/huskyCI/badge.svg?branch=master"/></a>
   <a href="https://circleci.com/gh/globocom/huskyCI/tree/master"><img src="https://img.shields.io/circleci/build/github/globocom/huskyCI/master?token=415bfb6b5aa0dfce8d2129878a66326da9533150"/></a>
-  <a href="https://gitter.im/globocom/huskyCI"><img src="https://badges.gitter.im/globocom/huskyCI.svg"/></a>
-  <a href="https://github.com/globocom/huskyCI/wiki"><img src="https://img.shields.io/badge/docs-wiki-informational"/></a>
-  <a href="https://github.com/rafaveira3/writing-and-presentations/blob/master/DEFCON-27-APP-SEC-VILLAGE-Rafael-Santos-huskyCI-Finding-security-flaws-in-CI-before-deploying-them.pdf"><img src="https://img.shields.io/badge/DEFCON%2027-AppSec%20Village-blueviolet"/></a>
-  <a href="https://www.blackhat.com/eu-19/arsenal/schedule/#huskyci-performing-security-tests-inside-your-ci-17792"><img src="https://img.shields.io/badge/Black%20Hat%20Arsenal-Europe%202019-black"/></a>
-
+  <a href="https://github.com/rafaveira3/writing-and-presentations/blob/master/DEFCON-27-APP-SEC-VILLAGE-Rafael-Santos-huskyCI-Finding-security-flaws-in-CI-before-deploying-them.pdf"><img src="https://img.shields.io/badge/DEFCON%2027-AppSec%20Village-black"/></a>
+<a href="https://github.com/rafaveira3/contributions/blob/master/huskyCI-BlackHat-Europe-2019.pdf"><img src="https://img.shields.io/badge/Black%20Hat%20Europe%202019-Arsenal-black"/></a>
 </p>
 
-huskyCI is an open-source tool that performs security tests inside CI pipelines of multiple projects and centralizes all results into a database for further analysis and metrics.
-
-## How does it work?
-
-The main goal of this project is to help development teams improve the quality of their code by finding vulnerabilities as quickly as possible, and thus addressing them.
-
-huskyCI can perform static security analysis in Python ([Bandit][Bandit] and [Safety][Safety]), Ruby ([Brakeman][Brakeman]), JavaScript ([Npm Audit][NpmAudit] and [Yarn Audit][YarnAudit]), Golang ([Gosec][Gosec]), and Java([SpotBugs][SpotBugs] plus [Find Sec Bugs][FindSec]). It can also audit repositories for secrets like AWS Secret Keys, Private SSH Keys, and many others using [GitLeaks][Gitleaks]. You should check our [wiki](https://github.com/globocom/huskyCI/wiki/How-does-huskyCI-work%3F) to better understand how this tool could help securing your organization projects!
-
-<p align="center">
-  <img src="huskyCI.gif" />
-</p>
-
-## Requirements
-
-### Docker and Docker-Compose
-
-The easiest way to deploy huskyCI locally is by using [Docker][Docker Install] and [Docker Compose][Docker Compose Install], thus you should have them installed on your machine.
-
-### Golang
-
-You must also have [Go](https://golang.org/doc/install) installed and huskyCI needs to be inside your [$GOPATH](https://github.com/golang/go/wiki/GOPATH) to run properly.
-
-## Installing
+## Introduction
 
-After cloning this repository, simply run the command inside huskyCI's folder:
+huskyCI is an open source tool that orchestrates security tests and centralizes all results into a database for further analysis and metrics. It can perform static security analysis in Python ([Bandit][Bandit] and [Safety][Safety]), Ruby ([Brakeman][Brakeman]), JavaScript ([Npm Audit][NpmAudit] and [Yarn Audit][YarnAudit]), Golang ([Gosec][Gosec]), and Java ([SpotBugs][SpotBugs] plus [Find Sec Bugs][FindSec]). It can also audit repositories for secrets like AWS Secret Keys, Private SSH Keys, and many others using [GitLeaks][Gitleaks].
 
-```sh
-make install
-```
-
-## Running
+## How does it work?
 
-After installing, an `.env` file with instructions to huskyCI should be generated:
+Developers can set up a new stage into their CI pipelines to check for vulnerabilities:
 
-```sh
-$ cat .env
-export HUSKYCI_CLIENT_REPO_URL="https://github.com/globocom/huskyCI.git"
-export HUSKYCI_CLIENT_REPO_BRANCH="vulns-Golang"
-export HUSKYCI_CLIENT_API_ADDR="http://localhost:8888"
-export HUSKYCI_CLIENT_API_USE_HTTPS="false"
-export HUSKYCI_CLIENT_TOKEN="{YOUR_TOKEN_HERE}"
-```
+<p align="center"><img src="huskyCI-stage.png"/></p>
 
-You can change the repository and branch being analysed by modifying the contents of `HUSKYCI_CLIENT_REPO_URL` and `HUSKYCI_CLIENT_REPO_BRANCH`. Then simply source it through the command:
+If security issues are found in the code, the severity, the confidence, the file, the line, and many more useful information can be shown, as exemplified: 
 
-```sh
-. .env
 ```
-
-Mac OS:
-
-```sh
-make run-client
+[HUSKYCI][*] poc-python-bandit -> https://github.com/globocom/huskyCI.git
+[HUSKYCI][*] huskyCI analysis started! yDS9tb9mdt4QnnyvOBp3eVAXE1nWpTRQ
+
+[HUSKYCI][!] Language: Python
+[HUSKYCI][!] Tool: Bandit
+[HUSKYCI][!] Severity: MEDIUM
+[HUSKYCI][!] Confidence: HIGH
+[HUSKYCI][!] Details: Use of exec detected.
+[HUSKYCI][!] File: ./main.py
+[HUSKYCI][!] Line: 7
+[HUSKYCI][!] Code:
+6 
+7 exec(command)
+8 
+
+[HUSKYCI][SUMMARY] Python -> huskyci/bandit:1.6.2
+[HUSKYCI][SUMMARY] High: 0
+[HUSKYCI][SUMMARY] Medium: 1
+[HUSKYCI][SUMMARY] Low: 0
+[HUSKYCI][SUMMARY] NoSecHusky: 0
+
+[HUSKYCI][SUMMARY] Total
+[HUSKYCI][SUMMARY] High: 0
+[HUSKYCI][SUMMARY] Medium: 1
+[HUSKYCI][SUMMARY] Low: 0
+[HUSKYCI][SUMMARY] NoSecHusky: 0
+
+[HUSKYCI][*] Some HIGH/MEDIUM issues were found :(
+ERROR: Job failed: exit code 1
 ```
 
-Linux:
-
-```sh
-make run-client-linux
-```
+## Getting Started
 
-## Frontend
+You can try huskyCI by setting up a local environment using Docker Compose following [this guide](http://201.7.182.242/docs/development/set-up-environment).
 
-huskyCI has also a cool [Frontend](https://github.com/globocom/huskyCI-dashboard) built in React so you can check some stats regarding your huskyCI results! After running your first scan, simply visit:
+## Documentation
 
-```
-http://localhost:8080
-```
+All guides and the full documentation can be found in the [official documentation page](http://201.7.182.242/docs/quickstart/overview).
 
-<p align="center"><img src="https://github.com/globocom/huskyCI-dashboard/raw/master/charts.png"/></p>
+## Contributing
 
+Read our [contributing guide](https://github.com/globocom/huskyCI/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to huskyCI.
 
+## Communication
 
-## Contributing
+We have a few channels for contact, feel free to reach out to us at:
 
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our Code of Conduct and the process for submitting pull requests to huskyCI.
+- [GitHub Issues](https://github.com/globocom/huskyCI/issues)
+- [Gitter](https://gitter.im/globocom/huskyCI)
+- [Twitter](https://twitter.com/huskyCI)
 
-## Documentation
+## Contributors
 
-You can find huskyCI documentation [here](https://github.com/globocom/huskyCI/wiki).
+This project exists thanks to all the [contributors]((https://github.com/globocom/huskyCI/graphs/contributors)). You rock!   ❤️🚀
 
 ## License
 
-This project is licensed under the BSD 3-Clause "New" or "Revised" License - read [LICENSE.md](LICENSE.md) file for details.
+huskyCI is licensed under the [BSD 3-Clause "New" or "Revised" License](https://github.com/globocom/huskyCI/blob/master/LICENSE.md).
 
-[Docker Install]:  https://docs.docker.com/install/
-[Docker Compose Install]: https://docs.docker.com/compose/install/
-[huskyCI Client]: https://github.com/globocom/huskyCI-client
 [Bandit]: https://github.com/PyCQA/bandit
 [Safety]: https://github.com/pyupio/safety
 [Brakeman]: https://github.com/presidentbeef/brakeman
@@ -114,4 +90,4 @@ This project is licensed under the BSD 3-Clause "New" or "Revised" License - rea
 [YarnAudit]: https://yarnpkg.com/lang/en/docs/cli/audit/
 [Gitleaks]: https://github.com/zricethezav/gitleaks
 [SpotBugs]: https://spotbugs.github.io
-[FindSec]: https://find-sec-bugs.github.io
+[FindSec]: https://find-sec-bugs.github.io