Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kuromoka committed Oct 16, 2019
1 parent 02a6562 commit 0512ae7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -5,9 +5,9 @@ CircleCI Status is a VSCode extension to check CircleCI build status.
## Usage
- Set up CircleCi project and put YAML file to `.circleci/config.yml`.
- Set vscode configuration.
- `circleciStatus.apiToken` is required. See the [CircleCI docs](https://circleci.com/docs/api/#add-an-api-token) for getting API token.
- `circleciStatus.apiToken` is required. See [this page](https://circleci.com/docs/2.0/managing-api-tokens/#creating-a-personal-api-token) for getting API token.
- `circleciStatus.projectName` is optional. Defaults to your workspace folder name. If it's diffrent from CircleCi project name, you need to set this configuration to that name.
- `circleciStatus.userName` is optional. Defaults to username from [this API result](https://circleci.com/docs/api/#user). If you want to work on organization reposiroy, you need to set this configuration to organization name.
- `circleciStatus.userName` is optional. Defaults to username from API result. If you want to work on organization reposiroy, you need to set this configuration to organization name.
```json
{
"circleciStatus.apiToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
Expand Down

0 comments on commit 0512ae7

Please sign in to comment.