Skip to content

Commit c3fb36d

Browse files
committed
chore: updated readme
1 parent 0983891 commit c3fb36d

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ As it uses a GitHub action it's secure and very easy to integrate into your proj
1616

1717
The contributors list is fetched from [GitHub API](https://developer.github.com/v3/repos/statistics/).
1818

19+
## Contributors Readme Action Table
20+
21+
Below image shows the contributors table generated by this action.
22+
23+
![contributors readme](./assets/contributors-table.png)
24+
25+
> You can take it even furthur by mixing it up with bots, custom users and more. Check out the [example](./contributors.md) provided.
26+
1927
## Getting Started
2028

2129
### First Step
@@ -41,7 +49,7 @@ jobs:
4149
4250
That's it!
4351
44-
To add it to your to your existing workflow, append this to your current `.yml` workflow script.
52+
To add it to your to your existing workflow, **append** this to your current `.yml` workflow script.
4553

4654
```yml
4755
- uses: akhilmhdh/[email protected]
@@ -52,7 +60,7 @@ To add it to your to your existing workflow, append this to your current `.yml`
5260
### Second Step
5361

5462
1. Add a `README.md` file
55-
2. Add the below comment inside your `README.md` where you want it to appear.
63+
2. Add the below comment inside your `README.md` where you want it to **appear**.
5664

5765
```md
5866
<!-- readme: contributors -start -->
@@ -63,7 +71,7 @@ To add it to your to your existing workflow, append this to your current `.yml`
6371

6472
### But wait!!!
6573

66-
- What if you wanted to add direct collaborators of a project, no worries
74+
- What if you wanted to **add direct collaborators** of a project, no worries
6775

6876
```md
6977
## Collaborators
@@ -77,7 +85,7 @@ To add it to your to your existing workflow, append this to your current `.yml`
7785
<!-- readme: contributors -end -->
7886
```
7987

80-
- Now you decided that you want to join this into one list, no issue
88+
- Now you decided that you want to **join** this into one list, no issue
8189

8290
```md
8391
## Contributors
@@ -86,13 +94,13 @@ To add it to your to your existing workflow, append this to your current `.yml`
8694
<!-- readme: collaborators,contributors -end -->
8795
```
8896

89-
- Then you decided to add some github users who are important figure in this project
97+
- Then you decided to **add some github users** who are important figure in this project and want's to [**remove**](#operators) some users or bots, no worries
9098

9199
```md
92100
## Contributors
93101
94-
<!-- readme: <username1>,collaborators,<username2>,contributors -start -->
95-
<!-- readme: <username1>,collaborators,<username3>,contributors -end -->
102+
<!-- readme: <username1>,collaborators,<username2>,contributors,<username3>/- -start -->
103+
<!-- readme: <username1>,collaborators,<username3>,contributors,<username3>/- -end -->
96104
```
97105

98106
> The order of the list will be given priority. So username1 will appear first collaborators then username2 likewise.(No brackets for usernames)

assets/contributors-table.png

174 KB
Loading

0 commit comments

Comments
 (0)