Skip to content

Commit 294a7ae

Browse files
architectureclaude
andcommitted
Update Installation section to reflect GitHub Packages (GPR)
Replace stale build-from-source instructions with correct GPR Gemfile snippet, auth setup, and a note clarifying the misleading gem install command shown on the GitHub Packages UI. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 516d798 commit 294a7ae

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,24 @@ This gem mirrors the public interface of [elevenlabs-python](https://github.com/
44

55
## Installation
66

7-
Since this gem isn’t published on RubyGems yet, install it from the local source or Git:
7+
This gem is published to **GitHub Packages** (not RubyGems.org). Add the GitHub Packages source to your `Gemfile`:
88

9-
```bash
10-
git clone https://github.com/architecture/elevenlabs-ruby
11-
cd elevenlabs-ruby
12-
gem build elevenlabs-ruby.gemspec
13-
gem install ./elevenlabs-0.3.0.gem
9+
```ruby
10+
source "https://rubygems.pkg.github.com/architecture" do
11+
gem "elevenlabs", "0.3.0"
12+
end
1413
```
1514

16-
Or reference the GitHub repo/path directly from your `Gemfile`:
17-
18-
```ruby
19-
# Latest main branch
20-
gem "elevenlabs", git: "https://github.com/architecture/elevenlabs-ruby", branch: "main"
15+
GitHub Packages requires authentication. Create a [personal access token](https://github.com/settings/tokens) with `read:packages` scope and add it to `~/.gem/credentials`:
2116

22-
# Specific tag/commit
23-
gem "elevenlabs", git: "https://github.com/architecture/elevenlabs-ruby", tag: "v0.3.0"
24-
# or
25-
gem "elevenlabs", path: "/path/to/elevenlabs-ruby"
2617
```
18+
---
19+
:github: Bearer <YOUR_TOKEN>
20+
```
21+
22+
Then run `bundle install`.
23+
24+
> **Note:** The `gem install elevenlabs` command shown on the GitHub Packages page points to RubyGems.org and will not work — this gem is only available via GitHub Packages.
2725
2826
## Quick start
2927

0 commit comments

Comments
 (0)