Skip to content

Commit f07ef0e

Browse files
fix: inaccuracies in the README.md
1 parent 9574fe5 commit f07ef0e

File tree

2 files changed

+5
-13
lines changed

2 files changed

+5
-13
lines changed

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,11 @@ gem "orb-billing", "~> 0.1.2"
2020

2121
<!-- x-release-please-end -->
2222

23-
To fetch an initial copy of the gem:
24-
25-
```sh
26-
bundle install
27-
```
28-
2923
## Usage
3024

3125
```ruby
3226
require "bundler/setup"
33-
require "orb-billing"
27+
require "orb"
3428

3529
orb = Orb::Client.new(
3630
api_key: "My API Key" # defaults to ENV["ORB_API_KEY"]
@@ -62,7 +56,7 @@ end
6256

6357
### Errors
6458

65-
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Orb::Error` will be thrown:
59+
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Orb::Errors::APIError` will be thrown:
6660

6761
```ruby
6862
begin
@@ -168,8 +162,7 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
168162
Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
169163

170164
```ruby
171-
params =
172-
Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
165+
params = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
173166
174167
orb.customers.create(**params)
175168
```
@@ -197,8 +190,7 @@ If you want to explicitly send an extra param, you can do so with the `extra_que
197190
To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
198191

199192
```ruby
200-
response =
201-
client.request(
193+
response = client.request(
202194
method: :post,
203195
path: '/undocumented/endpoint',
204196
query: {"dog": "woof"},

orb.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
88
s.summary = "Ruby library to access the Orb API"
99
s.authors = ["Orb"]
1010
s.email = "team@withorb.com"
11-
s.files = Dir["lib/**/*.rb", "rbi/**/*.rbi", "sig/**/*.rbs", "manifest.yaml"]
11+
s.files = Dir["lib/**/*.rb", "rbi/**/*.rbi", "sig/**/*.rbs", "manifest.yaml", "CHANGELOG.md", "SECURITY.md"]
1212
s.extra_rdoc_files = ["README.md"]
1313
s.required_ruby_version = ">= 3.0.0"
1414
s.add_dependency "connection_pool"

0 commit comments

Comments
 (0)