Skip to content
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

[BS-899] Update installation instructions to reference actual gem #2

Merged
merged 2 commits into from
Sep 26, 2024
+2 −4
Merged

[BS-899] Update installation instructions to reference actual gem #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9a97e5
[gitx] Start work on update-install-instructions
bryanhickerson Sep 26, 2024
43870a4
Update installation instructions to reference actual gem
bryanhickerson Sep 26, 2024
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
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -6,15 +6,13 @@ This gem adds a Ruby integration for Cortex's API.

## Installation

TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
$ bundle add cortex_app

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
$ gem install cortex_app

## Usage