This repository has been archived by the owner on Jan 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(ReadMe): update to reflect current usage
- Loading branch information
Showing
1 changed file
with
24 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,51 @@ | ||
| # Gamma Ray | ||
| [](https://goreportcard.com/report/github.com/dgonzalez/gammaray) | ||
|  | ||
| [](https://coveralls.io/github/dgonzalez/gammaray?branch=travis) | ||
| [](https://goreportcard.com/report/github.com/nearform/gammaray) | ||
|  | ||
| [](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. | ||
|
|
||
| ## Get It | ||
|
|
||
| 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/) |