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 12, 2018
commit e56e670e93223e8ba63333f2f0af64d57a3da6a1
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -39,7 +39,10 @@ Formats test report from local test suite into generalized format, readable by C

- `COVERAGE_FILE`
- Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found.


- `-d` or `--debug`
- Outputs debug messages during operation.

---

#### `sum-coverage`
@@ -66,6 +69,9 @@ Uploads formatted, singular test report to Code Climate API

- `-e URL` or `--endpoint URL`
- The endpoint to upload coverage information to. Defaults to the value in the `CC_TEST_REPORTER_COVERAGE_ENDPOINT` environment variable, or a hard-coded default (currently `https://codeclimate.com/test_reports`).

- `-d` or `--debug`
- Outputs debug messages during operation.

---

@@ -77,6 +83,9 @@ Combines `format-coverage` and `upload-coverage`

- `-p PATH` or `--prefix PATH`
- The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory.

- `-d` or `--debug`
- Outputs debug messages during operation.