Skip to content

Commit

Permalink
Update Ruby version and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rzhade3 committed Aug 9, 2024
1 parent 05dc74d commit ce7a0ae
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## [0.23.0] - 2024-08-09

[Add Asset and Organization resources](https://github.com/github/hackerone-client/pull/10) (@jeffgran-dox)

## [0.22.0] - 2024-01-10

[Update Faraday API call and deprecate support for Ruby <2.6](https://github.com/github/hackerone-client/pull/2) (@maclarel)
Expand Down
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hackerone::Client

A limited client library for interacting with HackerOne in Ruby. Currently only supports a few operations:
A limited client library for interacting with HackerOne in Ruby. Currently supports a few operations:

```ruby
client = HackerOne::Client::Api.new("github")
Expand Down Expand Up @@ -57,6 +57,23 @@ program.update_policy(policy: "Please submit valid vulnerabilities")

# Gets a program's balance
program.balance

# Gets a list of structured scopes
program.structured_scopes

# Gets an organization for a program
program.organization

# Gets assets for an organization
program.organization.assets

# Updates an asset for an organization
asset = program.organization.assets[0]
asset.update(
attributes: {
description: "This is the new description"
}
)
```

## State change hooks
Expand Down
2 changes: 1 addition & 1 deletion lib/hackerone/client/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

module Hackerone
module Client
VERSION = "0.22.1"
VERSION = "0.23.0"
end
end

0 comments on commit ce7a0ae

Please sign in to comment.