Skip to content

Commit

Permalink
Update readme with suggestions from tech writer (#5)
Browse files Browse the repository at this point in the history
* Update readme with suggestions from tech writer

* Update README.md

* Update README.md
  • Loading branch information
quan-nobl9 authored Dec 8, 2022
1 parent 22666d1 commit b8e0254
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# nobl9-action

This action applies a Nobl9 configuration file (specified at `sloctl_yml` input parameter) to a project using `sloctl` (https://docs.nobl9.com/sloctl-user-guide/) tool.
This action applies a Nobl9 configuration file (specified via the sloctl_yml input parameter) to a project using the `sloctl` (https://docs.nobl9.com/sloctl-user-guide/) tool.

## Requirements

- A valid nobl9 account must be activated (check https://nobl9.com for more information)
- A valid Nobl9 account (see https://nobl9.com for more information)

## Inputs

### `client_id`
The Client ID of your nobl9 account
The Client ID of your Nobl9 account

### `client_secret`
The Client Secret of your nobl9 account
The Client Secret of your Nobl9 account

### `access_token`
Access token used to authenticate the sloctl tool
The access token used to authenticate to the sloctl tool

### `project`
The project name on which the sloctl configuration will be applied to
The name of the project the configuration will be applied to

### `sloctl_yml`
The path to the sloctl yaml configuration file, relative to the root directory of the repository
The path to the sloctl YAML configuration file, relative to the root directory of the repository

## Example Usage

Expand Down

0 comments on commit b8e0254

Please # to comment.