diff --git a/README.md b/README.md index d039a7a..cd63d0f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -77,7 +85,7 @@ To add it to your to your existing workflow, append this to your current `.yml` ``` -- 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 @@ -86,13 +94,13 @@ To add it to your to your existing workflow, append this to your current `.yml` ``` -- 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 - - + + ``` > The order of the list will be given priority. So username1 will appear first collaborators then username2 likewise.(No brackets for usernames) diff --git a/assets/contributors-table.png b/assets/contributors-table.png new file mode 100644 index 0000000..d7ce7d7 Binary files /dev/null and b/assets/contributors-table.png differ