README.md in hackerone-client-0.9.0 vs README.md in hackerone-client-0.9.1
- old
+ new
@@ -13,33 +13,32 @@
# PUT '/reports/{id}/assignee'
report.assign_to_user("username")
report.assign_to_group("groupname")
-# POST /reports/{id}/bounty_suggestions
-report.suggest_bounty(message: "I suggest $500 with a small bonus. Report is well-written.", amount: 500, bonus_amount: 50)
-
-# POST /reports/{id}/bounties
-report.award_bounty(message: "Here's your bounty!", amount: 500, bonus_amount: 50)
-
-# POST /reports/{id}/swags
-report.award_swag(message: "Here's your T-Shirt")
-
# POST '/reports/#{id}/activities'
+report.add_comment(message, internal: false) # internal is true by default
-client.add_comment(id, message, internal: false) # internal is true by default
-
# POST '/report/{id}/state_change change the state of a report
# `state` can be one of new, triaged, needs-more-info, resolved, not-applicable, informative, duplicate, spam
-client.state_change(id, state)
+report.state_change(state)
# POST '/report/{id}/add_report_reference add a "reference" e.g. internal issue number
-client.add_report_reference(id, reference)
+report.add_report_reference(reference)
# Triage an issue (add a reference and set state to :triaged)
-client.triage(id, reference)
+report.triage(reference)
+# POST /reports/{id}/bounty_suggestions
+report.suggest_bounty(message: "I suggest $500 with a small bonus. Report is well-written.", amount: 500, bonus_amount: 50)
+
+# POST /reports/{id}/bounties
+report.award_bounty(message: "Here's your bounty!", amount: 500, bonus_amount: 50)
+
+# POST /reports/{id}/swags
+report.award_swag(message: "Here's your T-Shirt")
+
# GET `/{program}/reporters` returns a list of unique reporters that have reported to your program
client.reporters
program = HackerOne::Client::Program.find("insert-program-name-here")
@@ -49,17 +48,17 @@
## Usage
### Credential management
-You'll need to generate an API token at https://hackerone.com/<program>/api.
+You'll need to generate an API token at `https://hackerone.com/<program>/api`.
* Click "Create API token"
* Name the token
* Click "Create"
* Copy down the value
-Set the `HACKERONE_TOKEN` and `HACKERONE_TOKEN_NAME` environment variables.
+**Set the `HACKERONE_TOKEN` and `HACKERONE_TOKEN_NAME` environment variables.**
### Program name
In order to retrieve all reports for a given program, you need to supply a default program: