Skip to content

Commit

Permalink
Deploying from phrase/openapi@f047eaec
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Jun 11, 2020
1 parent 4d94bae commit 801accd
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 17 deletions.
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,42 +380,54 @@ For more information, please visit [https://developers.phrase.com/api/](https://

## Installation

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

To build the Ruby code into a gem:
Install from the command line:

```shell
gem build phrase.gemspec
$ gem install phrase
```

Then either install the gem locally:
Install via Gemfile:

gem "phrase"

### Install from GitHub Packages

Install from the command line:

```shell
gem install ./phrase-1.0.0.gem
$ gem install phrase-ruby --source "https://rubygems.pkg.github.com/phrase"
```

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

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

Finally add this to the Gemfile:
### Install from Git

gem 'phrase', '~> 1.0.0'
Add the following in the Gemfile:

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

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:
### Build and install a gem on your own

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

### Include the Ruby code directly
```shell
gem build phrase.gemspec
```

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

```shell
ruby -Ilib script.rb
gem install ./phrase-1.0.0.gem
```

(for development, run `gem install --dev ./phrase-1.0.0.gem` to install the development dependencies)

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:
Expand Down
4 changes: 2 additions & 2 deletions git_push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ if [ "$git_host" = "" ]; then
fi

if [ "$git_user_id" = "" ]; then
git_user_id="GIT_USER_ID"
git_user_id="phrase"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi

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

Expand Down

0 comments on commit 801accd

Please sign in to comment.