Skip to content

Commit

Permalink
chore: update README template
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosmmatos committed Jul 14, 2023
1 parent 49e2e56 commit 650c3e6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
12 changes: 6 additions & 6 deletions .openapi-generator/templates/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ gem install {{{gemName}}}
```

Add this to the Gemfile:

<!-- x-release-please-start-version -->
```ruby
gem '{{{gemName}}}', '~> {{{gemVersion}}}'
```

<!-- x-release-please-end -->
### From Source to Gem: Building the Ruby Code

To build the Ruby code into a gem:
Expand All @@ -31,17 +31,17 @@ gem build {{{gemName}}}.gemspec
```

Then install the gem locally:

<!-- x-release-please-start-version -->
```shell
gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
```

<!-- x-release-please-end -->
Finally, add this to the Gemfile:

<!-- x-release-please-start-version -->
```ruby
gem '{{{gemName}}}', '~> {{{gemVersion}}}'
```

<!-- x-release-please-end -->
### Install from Git

If the Ruby gem is hosted at a git repository: <https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}>, then add the following in the Gemfile:
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Add this to the Gemfile:
gem 'crimson-falcon', '~> 0.1.2'
```
<!-- x-release-please-end -->

### From Source to Gem: Building the Ruby Code

To build the Ruby code into a gem:
Expand Down

0 comments on commit 650c3e6

Please sign in to comment.