Skip to content

Commit 4095a2b

Browse files
📝 Updated contents
1 parent 76fb99a commit 4095a2b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ GitHub's Profile readme is a great tool to showcase your skills and projects to
1919
<!-- PROJECTS END -->
2020
```
2121

22-
- The repositories need to have `project` topic to add them to the project section.
22+
- The repositories need to have `project` topics to add them to the project section.
2323

2424
- A GitHub personal access token will be needed which can be obtained by going to Settings > Developer Settings > Personal Access Tokens.
2525
<div align="center"> <img src="./images/config.png" align="center"> </div>
@@ -29,14 +29,14 @@ _Note: If you give personal repositories access then they will be added to the s
2929

3030
## Action Setup
3131

32-
GitHub actions can be integrated in any repository. Create a new folder called `.github/workflows/<any-name>.yml`. Paste the following starter code:
32+
GitHub actions can be integrated into any repository. Create a new folder called `.github/workflows/<any-name>.yml`. Paste the following starter code:
3333

3434
```yml
3535
name: Update Projects
3636
on:
3737
schedule:
3838
- cron: '0 0 * * *'
39-
# This makes the action to run at the end of every day. Customize this accordingly or you can also trigger this action for GitHub events (Pull, Push). Check the GitHub actions page for that.
39+
# This makes the action run at the end of every day. Customize this accordingly or you can also trigger this action for GitHub events (Pull, Push). Check the GitHub actions page for that.
4040
workflow_dispatch:
4141
# workflow_dispatch allows you to trigger the action any time manually
4242

@@ -56,9 +56,9 @@ jobs:
5656
| Option | Default Value | Description | Required | Example |
5757
| -------------- | ------------- | ---------------------------------------------------------------------------- | -------- | ------- |
5858
| `gh_token` | NA | GitHub Personal Access token | Yes | NA |
59-
| `file_name` | `README.md` | Name of the readme file or any other file containing the comment mentioned above. Note: The file needs to be in root of repository. (Dynamic paths coming in next version!) | No | myfile.txt/ myfile.html |
59+
| `file_name` | `README.md` | Name of the readme file or any other file containing the comment mentioned above. Note: The file needs to be at the root of the repository. (Dynamic paths coming in next version!) | No | myfile.txt/ myfile.html |
6060
| `max_repo_description` | 50 | How much description you want to Display | No | 40 |
61-
| `allow_forks` | True | Control if you want to display number of forks of the repository | No | False |
61+
| `allow_forks` | True | Control if you want to display the number of forks of the repository | No | False |
6262

6363
## Examples
6464
- [My Workflow File](https://github.com/kaustubhgupta/kaustubhgupta/blob/master/.github/workflows/project-updater.yml)

0 commit comments

Comments
 (0)