Update README.md

This commit is contained in:
Luke Hagar
2024-06-14 16:03:30 -05:00
parent eb49c1835e
commit eba2296e9d

View File

@@ -7,6 +7,7 @@ A GitHub action to automate the collection of stats for a users GitHub profile.
Please see [this workflow](https://github.com/LukeHagar/stats/blob/23adb0a0cb2a283a30300478a2834b9766440b05/.github/workflows/generate-stats.yaml#L24C15-L24C37) to see this Action in use Please see [this workflow](https://github.com/LukeHagar/stats/blob/23adb0a0cb2a283a30300478a2834b9766440b05/.github/workflows/generate-stats.yaml#L24C15-L24C37) to see this Action in use
When this action is run it creates a `github-stats.json` file in the root of the repository. When this action is run it creates a `github-stats.json` file in the root of the repository.
This file contains all of the GitHub stats collected for the user. This file contains all of the GitHub stats collected for the user.
You can use [this template repository](https://github.com/LukeHagar/stats/) and follow the [instructions in the Readme](https://github.com/LukeHagar/stats/?tab=readme-ov-file#github-repo-template) to collect stats for yourself. You can use [this template repository](https://github.com/LukeHagar/stats/) and follow the [instructions in the Readme](https://github.com/LukeHagar/stats/?tab=readme-ov-file#github-repo-template) to collect stats for yourself.