Skip to content

Commit

Permalink
fix: README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosmmatos committed Jul 14, 2023
1 parent 588a8a8 commit 32e093c
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ gem install crimson-falcon
```

Add this to the Gemfile:

<!-- x-release-please-start-version -->
```ruby
gem 'crimson-falcon', '~> 0.1.1'
```
<!-- x-release-please-end -->

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

Expand All @@ -31,17 +32,17 @@ gem build crimson-falcon.gemspec
```

Then install the gem locally:

<!-- x-release-please-start-version -->
```shell
gem install ./crimson-falcon-0.1.1.gem
```

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

<!-- x-release-please-start-version -->
```ruby
gem 'crimson-falcon', '~> 0.1.1'
```

<!-- x-release-please-end -->
### Install from 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:
Expand Down Expand Up @@ -114,7 +115,7 @@ Welcome aboard the Crimson Falcon! Fly high, code with grace.

- **Operation**: [**patch_entities_alerts_v2**](docs/AlertsApi.md#patch_entities_alerts_v2)
- **PATCH**: /alerts/entities/alerts/v2
- **Description**: Perform actions on detections identified by detection ID(s) in request. Each action has a name and a description which describes what the action does. If a request adds and removes tag in a single request, the order of processing would be to remove tags before adding new ones in.
- **Description**: Perform actions on detections identified by detection ID(s) in request. Each action has a name and a description which describes what the action does. If a request adds and removes tag in a single request, the order of processing would be to remove tags before adding new ones in.

---

Expand Down Expand Up @@ -2594,7 +2595,7 @@ Welcome aboard the Crimson Falcon! Fly high, code with grace.

- **Operation**: [**add_role**](docs/MsspApi.md#add_role)
- **POST**: /mssp/entities/mssp-roles/v1
- **Description**: Create a link between user group and CID group, with zero or more additional roles. The call does not replace any existing link between them. User group ID and CID group ID have to be specified in request.
- **Description**: Create a link between user group and CID group, with zero or more additional roles. The call does not replace any existing link between them. User group ID and CID group ID have to be specified in request.

---

Expand Down

0 comments on commit 32e093c

Please sign in to comment.