Skip to content

Commit 6e46a68

Browse files
authored
Text changes (#1)
* Update ReadMe I have added two sections relating to permissions and one for teh over text. I think this should be enough for now. -H * Update README.md * Update README.md
1 parent 0249494 commit 6e46a68

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,17 @@
99
</h1>
1010

1111
<p align="center">
12-
This action helps you to keep in sync your PRs with your Teamwork tasks.
12+
This action helps you to sync your PRs with tasks in Teamwork to streamline team collaboration and your development workflows.
1313
</p>
1414

1515
## Getting Started
1616

1717
### Prerequisites
1818
Create the next environment vars in your repository:
1919
* `TEAMWORK_URI`: The URL of your installation (e.g.: https://yourcompany.teamwork.com)
20-
* `TEAMWORK_API_TOKEN`: The API token to authenticate the workflow
20+
* `TEAMWORK_API_TOKEN`: The API token to authenticate the workflow. Follow [this guide](https://developer.teamwork.com/guides/api-key-url/) to find your URL and API key.
21+
22+
**Please Note:** The Teamwork account associated with this API key is the account which these comments will be created under. If this user does not have permission to access the project, this action will be ignored.
2123

2224
`GITHUB_TOKEN` doesn't need to be setup in the repository, this var is always available during the workflows execution.
2325

@@ -50,7 +52,9 @@ jobs:
5052
```
5153
5254
## Usage
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.
55+
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.
56+
57+
Please note, the comment will be created in Teamwork under the account you have attached to this action. If the API key of the user you are using does not have permissions to access certain projects, the comment will not be created.
5458
5559
![github pr comment](./.github/assets/github_pr_comment.png)
5660

0 commit comments

Comments
 (0)