diff --git a/README.md b/README.md index 0793471..0a93819 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ ## Usage +To integrate Codecov with your Actions pipline, specify the name of this repository with a tag number as a 'step' within your 'workflow.yml' file. Optionally, you can choose to include up to four different inputs to customize the upload context. + Inside your `.github/workflows/workflow.yml` file: ```yaml @@ -21,6 +23,8 @@ steps: ## Arguments +Codecov's Action currently supports four inputs from the user: `token`, `file`, `flags`, and `name`. These inputs help users contexualize more information about their upload on [codecov.io](https://www.codecov.io). + | Input | Description | Usage | | :---: | :---: | :---: | | `token` | Used to authorize coverage report uploads | *Required only for private repos* |