Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akhilmhdh committed Aug 8, 2022
1 parent 0983891 commit c3fb36d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ As it uses a GitHub action it's secure and very easy to integrate into your proj

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

## Contributors Readme Action Table

Below image shows the contributors table generated by this action.

![contributors readme](./assets/contributors-table.png)

> You can take it even furthur by mixing it up with bots, custom users and more. Check out the [example](./contributors.md) provided.
## Getting Started

### First Step
Expand All @@ -41,7 +49,7 @@ jobs:
That's it!
To add it to your to your existing workflow, append this to your current `.yml` workflow script.
To add it to your to your existing workflow, **append** this to your current `.yml` workflow script.

```yml
- uses: akhilmhdh/contributors-readme-action@v2.3.6
Expand All @@ -52,7 +60,7 @@ To add it to your to your existing workflow, append this to your current `.yml`
### Second Step

1. Add a `README.md` file
2. Add the below comment inside your `README.md` where you want it to appear.
2. Add the below comment inside your `README.md` where you want it to **appear**.

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

### But wait!!!

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

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

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

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

- Then you decided to add some github users who are important figure in this project
- 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

```md
## Contributors
<!-- readme: <username1>,collaborators,<username2>,contributors -start -->
<!-- readme: <username1>,collaborators,<username3>,contributors -end -->
<!-- readme: <username1>,collaborators,<username2>,contributors,<username3>/- -start -->
<!-- readme: <username1>,collaborators,<username3>,contributors,<username3>/- -end -->
```

> The order of the list will be given priority. So username1 will appear first collaborators then username2 likewise.(No brackets for usernames)
Expand Down
Binary file added assets/contributors-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c3fb36d

Please sign in to comment.