Skip to content

Commit 801accd

Browse files
author
Phrase
committed
Deploying from phrase/openapi@f047eaec
1 parent 4d94bae commit 801accd

File tree

2 files changed

+29
-17
lines changed

2 files changed

+29
-17
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -380,42 +380,54 @@ For more information, please visit [https://developers.phrase.com/api/](https://
380380

381381
## Installation
382382

383-
### Build a gem
383+
### Install from [rubygems.org](https://rubygems.org/)
384384

385-
To build the Ruby code into a gem:
385+
Install from the command line:
386386

387387
```shell
388-
gem build phrase.gemspec
388+
$ gem install phrase
389389
```
390390

391-
Then either install the gem locally:
391+
Install via Gemfile:
392+
393+
gem "phrase"
394+
395+
### Install from GitHub Packages
396+
397+
Install from the command line:
392398

393399
```shell
394-
gem install ./phrase-1.0.0.gem
400+
$ gem install phrase-ruby --source "https://rubygems.pkg.github.com/phrase"
395401
```
396402

397-
(for development, run `gem install --dev ./phrase-1.0.0.gem` to install the development dependencies)
403+
Install via Gemfile:
398404

399-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
405+
source "https://rubygems.pkg.github.com/phrase" do
406+
gem "phrase-ruby"
407+
end
400408

401-
Finally add this to the Gemfile:
409+
### Install from Git
402410

403-
gem 'phrase', '~> 1.0.0'
411+
Add the following in the Gemfile:
404412

405-
### Install from Git
413+
gem 'phrase', git: 'https://github.com/phrase/phrase-ruby.git'
406414

407-
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
415+
### Build and install a gem on your own
408416

409-
gem 'phrase', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
417+
To build the Ruby code into a gem:
410418

411-
### Include the Ruby code directly
419+
```shell
420+
gem build phrase.gemspec
421+
```
412422

413-
Include the Ruby code directly using `-I` as follows:
423+
Then install the gem locally:
414424

415425
```shell
416-
ruby -Ilib script.rb
426+
gem install ./phrase-1.0.0.gem
417427
```
418428

429+
(for development, run `gem install --dev ./phrase-1.0.0.gem` to install the development dependencies)
430+
419431
## Getting Started
420432

421433
Please follow the [installation](#installation) procedure and then run the following code:

git_push.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ if [ "$git_host" = "" ]; then
1414
fi
1515

1616
if [ "$git_user_id" = "" ]; then
17-
git_user_id="GIT_USER_ID"
17+
git_user_id="phrase"
1818
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
1919
fi
2020

2121
if [ "$git_repo_id" = "" ]; then
22-
git_repo_id="GIT_REPO_ID"
22+
git_repo_id="phrase-ruby"
2323
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
2424
fi
2525

0 commit comments

Comments
 (0)