From 7c9d694253f4b1fd368341f60af819e0f07fa286 Mon Sep 17 00:00:00 2001
From: Miguel Savignano <miguel.savignano@the-cocktail.com>
Date: Fri, 1 Nov 2019 18:49:40 +0100
Subject: [PATCH] update README

---
 README.md | 89 ++++++++++++-------------------------------------------
 1 file changed, 19 insertions(+), 70 deletions(-)

diff --git a/README.md b/README.md
index ecee12c..22f261c 100644
--- a/README.md
+++ b/README.md
@@ -1,77 +1,26 @@
-![Rubocop](https://github.com/andrewmcodes/rubocop-linter-action/workflows/Rubocop/badge.svg)
-![Tests](https://github.com/andrewmcodes/rubocop-linter-action/workflows/Test/badge.svg)
-![Version Number](https://img.shields.io/static/v1?label=Version&message=v1.0.0&color=blue)
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors)
+## Brakeman github action
 
-# Rubocop Linter Action
+### Usage
 
-GitHub Action to run Rubocop against your code and create annotations in the UI.
-
-**NOTE: due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.**
-
-## Usage
-
-Add the following to your GitHub action workflow:
-
-```yaml
-- name: Rubocop Linter
-  uses: andrewmcodes/rubocop-linter-action@v1.0.0
+```yml
+- name: Brakeman
+  uses: devmasx/brakeman-lint-action@v1.0.0
   env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 ```
 
-## Example Workflow
+### Custom report
 
-```yaml
-name: Rubocop
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Rubocop Linter
-      uses: andrewmcodes/rubocop-linter-action@v1.0.0
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```yml
+- name: Install gems
+  run: |
+    gem install brakeman -v 4.5.0
+- name: brakeman report
+  run: |
+    brakeman -f json > tmp/brakeman.json || exit 0
+- name: Brakeman
+  uses: devmasx/brakeman-lint-action@v1.0.0
+  env:
+    GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    REPORT_PATH: tmp/brakeman.json
 ```
-
-## Screenshots
-
-![example GitHub Action UI](screenshots/ui-example.png)
-
-## Contributing
-
-[Contributing Guide](/CONTRIBUTING.md)
-
-## Code of Conduct
-
-[Code of Conduct](/CODE_OF_CONDUCT.md)
-
-## License
-
-[MIT](/LICENSE.md)
-
-## Recognition
-
-This project was originally forked from [gimenete/rubocop-action](https://github.com/gimenete/rubocop-action). Many thanks to [Alberto Gimeno](https://github.com/gimenete) for creating this project.
-
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore -->
-<table>
-  <tr>
-    <td align="center"><a href="https://www.andrewmason.me/"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4" width="100px;" alt="Andrew Mason"/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="#infra-andrewmcodes" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#review-andrewmcodes" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/andrewmcodes/rubocop-linter-action/commits?author=andrewmcodes" title="Documentation">📖</a> <a href="https://github.com/andrewmcodes/rubocop-linter-action/commits?author=andrewmcodes" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/MiguelSavignano"><img src="https://avatars3.githubusercontent.com/u/6641863?v=4" width="100px;" alt="Miguel Savignano"/><br /><sub><b>Miguel Savignano</b></sub></a><br /><a href="#infra-MiguelSavignano" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/andrewmcodes/rubocop-linter-action/commits?author=MiguelSavignano" title="Tests">⚠️</a> <a href="https://github.com/andrewmcodes/rubocop-linter-action/commits?author=MiguelSavignano" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/mcgregordan"><img src="https://avatars0.githubusercontent.com/u/17787076?v=4" width="100px;" alt="Dan McGregor"/><br /><sub><b>Dan McGregor</b></sub></a><br /><a href="https://github.com/andrewmcodes/rubocop-linter-action/commits?author=mcgregordan" title="Documentation">📖</a></td>
-  </tr>
-</table>
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!