From 30e5cbb04667c78dc49bc2e8df7c1ce4bc92b702 Mon Sep 17 00:00:00 2001
From: Florian Traverse <florian.traverse@rocksolead.com>
Date: Tue, 24 Jul 2018 09:20:32 +0200
Subject: [PATCH] docs(ReadMe): update to reflect current usage

---
 README.md | 39 ++++++++++++++++++++++++---------------
 1 file changed, 24 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index aa5588b..7f4aab8 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
 # Gamma Ray
-[![Go Report Card](https://goreportcard.com/badge/github.com/dgonzalez/gammaray)](https://goreportcard.com/report/github.com/dgonzalez/gammaray)
-![Travis](https://travis-ci.org/dgonzalez/gammaray.svg?branch=master)
-[![Coverage Status](https://coveralls.io/repos/github/dgonzalez/gammaray/badge.svg?branch=travis)](https://coveralls.io/github/dgonzalez/gammaray?branch=travis)
+[![Go Report Card](https://goreportcard.com/badge/github.com/nearform/gammaray)](https://goreportcard.com/report/github.com/nearform/gammaray)
+![Travis](https://travis-ci.org/nearform/gammaray.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/nearform/gammaray/badge.svg?branch=master)](https://coveralls.io/github/nearform/gammaray?branch=master)
 
-Gamm Ray is a software that helps developers to look for vulnerabilities on their Node.js
+Gammaray is a software that helps developers to look for vulnerabilities on their Node.js
 applications. Its pluggable infrastructure makes very easy to write an integration with
 several vulnerabilities databases.
 
@@ -11,32 +11,41 @@ several vulnerabilities databases.
 
 In order to get it just run:
 
-```
-go get github.com/dgonzalez/gammaray
+```console
+$> go get github.com/nearform/gammaray
 ```
 Once it is finished, you should have the `gammaray` binary in your `GOPATH/bin` folder.
 
 ## Build it
 
-We use `dep` to manage the dependencies for `gammaray`. In order to build it, run:
-
-```
-dep ensure
-go build
+```console
+$> make
 ```
 
 ## Usage
 
 Gammaray comes as a single binary so you only need to run it passing your project as argument:
 
-```
-gammaray <path-to-your-node-app>
+```console
+$> gammaray <path-to-your-node-app>
 ```
 
 And that is all, all the vulnerabilities that affect your packages will be displayed.
 
 ## Contributing
 
-Are you a developer and want to contribute? Please be my guest.
+### As a developer
+
+Clone the repository, then start hacking, PRs are welcome !
+
+```console
+$> mkdir -p $GOPATH/src/github.com/nearform/
+$> cd $GOPATH/src/github.com/nearform/
+$> git clone https://github.com/nearform/gammaray.git
+$> cd gammaray
+$> make dev-install
+```
+
+### As security provider
 
-Are you a security provider who wants to be integrated? Contact me [here](https://www.linkedin.com/in/david-gonzalez-microservices/)
+You want to be integrated? Contact me [here](https://www.linkedin.com/in/david-gonzalez-microservices/)