Skip to content

Commit 1a44e7c

Browse files
Update README file
1 parent 36392b0 commit 1a44e7c

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ Create the next environment vars in your repository:
1919
* `TEAMWORK_URI`: The URL of your installation (e.g.: https://yourcompany.teamwork.com)
2020
* `TEAMWORK_API_TOKEN`: The API token to authenticate the workflow
2121

22+
`GITHUB_TOKEN` doesn't need to be setup in the repository, this var is always available during the workflows execution.
23+
2224
### Installation
23-
Create a new file `/.github/workflows/teamwork.yml`
25+
Create a new file `/.github/workflows/teamwork.yml` with the following:
2426

2527
```yaml
2628
name: teamwork
@@ -48,7 +50,7 @@ jobs:
4850
```
4951
5052
## Usage
51-
When creating a new PR, write in the description of the PR the URL of the task and the action will automatically add a comment directly in the task.
53+
When creating a new PR, write in the description of the PR the URL of the task. The action will automatically add a comment in the task.
5254
5355
## Contributing
5456
* Open a PR: https://github.com/miguelbemartin/teamwork-github/pulls

0 commit comments

Comments
 (0)