Skip to content

chore: update readme #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2025
Merged

chore: update readme #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ The underlying REST API documentation can be found on [platform.openai.com](http

## Installation

To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
To use this gem, install via Bundler by adding the following to your application's `Gemfile`:

```ruby
gem "openai", git: "https://github.com/openai/openai-ruby", branch: "main"
gem "openai", "~> 0.1.0.pre.alpha.2"
```

To fetch an initial copy of the gem:
Expand All @@ -22,12 +22,6 @@ To fetch an initial copy of the gem:
bundle install
```

To update the version used by your application when updates are pushed to GitHub:

```sh
bundle update openai
```

## Usage

```ruby
Expand Down