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.

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

add list of subcommands to README.md #374

Open
wants to merge 27 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
davehenton authored Nov 7, 2018
commit 7476e639785e916782f84ca8edc8324f174548a0
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ Some installations may require the use of the following [subcommands](https://do



### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate
#### `format-coverage` - formats test report from local test suite into generalized format, readable by Code Climate

- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE

@@ -39,7 +39,7 @@ Some installations may require the use of the following [subcommands](https://do



## `upload-coverage` - uploads formatted, singular test report to Code Climate API
#### `upload-coverage` - uploads formatted, singular test report to Code Climate API

- `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json.

@@ -51,7 +51,7 @@ Some installations may require the use of the following [subcommands](https://do



## `after-build` - combines `format-coverage` and `upload-coverage`
#### `after-build` - combines `format-coverage` and `upload-coverage`