You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# Browserbase Ruby API library
1
+
# Stagehand Ruby API library
2
2
3
-
The Browserbase Ruby library provides convenient access to the Browserbase REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/browserbase/stagehand-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
3
+
The Stagehand Ruby library provides convenient access to the Stagehand REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/browserbase/stagehand-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
4
4
5
5
It is generated with [Stainless](https://www.stainless.com/).
6
6
7
7
## Documentation
8
8
9
9
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/stagehand).
10
10
11
-
The REST API documentation can be found on [browserbase.com](https://browserbase.com).
11
+
The REST API documentation can be found on [docs.stagehand.dev](https://docs.stagehand.dev).
12
12
13
13
## Installation
14
14
@@ -28,12 +28,12 @@ gem "stagehand", "~> 0.0.1"
28
28
require"bundler/setup"
29
29
require"stagehand"
30
30
31
-
browserbase=Stagehand::Client.new(
31
+
stagehand=Stagehand::Client.new(
32
32
api_key:ENV["STAGEHAND_API_KEY"], # This is the default and can be omitted
33
33
environment:"dev"# or "production" | "local"; defaults to "production"
34
34
)
35
35
36
-
response =browserbase.sessions.start(env:"LOCAL")
36
+
response =stagehand.sessions.start(env:"LOCAL")
37
37
38
38
puts(response.available)
39
39
```
@@ -44,7 +44,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
44
44
45
45
```ruby
46
46
begin
47
-
session =browserbase.sessions.start(env:"LOCAL")
47
+
session =stagehand.sessions.start(env:"LOCAL")
48
48
rescueStagehand::Errors::APIConnectionError => e
49
49
puts("The server could not be reached")
50
50
puts(e.cause) # an underlying Exception, likely raised within `net/http`
@@ -82,12 +82,12 @@ You can use the `max_retries` option to configure or disable this:
0 commit comments