Skip to content

Commit 2a71a96

Browse files
authored
Update README.md
Fixes #3
1 parent c96f76b commit 2a71a96

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ Please feel free to fork it or contribute to it.
1212

1313
## Usage
1414

15+
You can add this action to any repository other than profile repository (special repository). This action will add a line for every repository (that the action is activated) to the README file of the special repository.
16+
1517
Follow the steps;
1618
- Create your special repository if not exists.
1719
- Add `<!-- START gadpp -->` add the end of the README.md file of the special repo.
1820
- Create a personal access token [here](https://github.com/settings/tokens) and set the `repo` permission.
1921
- Add the access token created in previous step to the repository (that uses this action) as a secret with name `API_TOKEN_GITHUB`.
20-
- Create the YML file for the action under `.github/workflows`. You can use the sample given below. Please update `YOUR_GITHUB_USERNAME` and `EMAIL_USED_ON_GITHUB` values.
22+
- Create the YML file for the action under `.github/workflows` of the repository (the one which is not the special repository). You can use the sample given below. Please update `YOUR_GITHUB_USERNAME` and `EMAIL_USED_ON_GITHUB` values.
2123
- Please do not forget to add checkout step before GADPP step in your pipeline.
2224

2325
## Example YML File To Create A Workflow With This Action

0 commit comments

Comments
 (0)