Remove screenshots and list custom flags

README.md

@@ -6,9 +6,19 @@ You can read more about Brakeman itself [here](https://github.com/presidentbeef/
 
 This action helps make sure that brakeman results get accurately added to pull requests, in the event of a new issue.
 
-Currently we hardcode the brakeman version (5.2.1) to prevent the unintended consequences of pulling down the latest version
+Currently we recommend hardcoding the brakeman version (e.g. 5.2.1) to prevent the unintended consequences of pulling down the latest version
 regardless of context.
 
+## Config options
+
+These are the (required or recommended) options you can set for the runner.
+
+- GITHUB_TOKEN (required): the [github token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication), naturally :)
+- REPORT_PATH: Where on the action runner you want the report to go, e.g. "/tmp/report.json". If not set, just outputs a json string.
+- PROJECT_PATH: The path of the project you want to scan (in case you have multiple apps in a repo). Defaults to the value of the [GITHUB_WORKSPACE](https://docs.github.com/en/actions/learn-github-actions/environment-variables) envvar.
+- GITHUB_LATEST_SHA: recommend setting this, it tells the runner where to put review comments. Easiest set as  `${{ github.event.pull_request.head.sha }}`
+- CUSTOM_MESSAGE_CONTENT: Something custom you want to add to the PR comments, e.g. a runbook or an emoji or a friendly message. Note that if you want a line break in CUSTOM_MESSAGE_CONTENT it is recommended to use `<br />` tags.
+
 ### Usage
 
 ```yml
@@ -64,9 +74,4 @@ jobs:
         CUSTOM_MESSAGE_CONTENT: "This is a cool, friendly comment!<br />Thank you for improving our security!"
 ```
 
-Note that if you want a line break in CUSTOM_MESSAGE_CONTENT it is recommended to use `<br />` tags.
-
-## Screenshots
-
-![example GitHub Action UI](./screenshots/action.png)
-![example Pull request](./screenshots/pull_request.png)
+Remember: if you want a line break in CUSTOM_MESSAGE_CONTENT it is recommended to use `<br />` tags.