diff --git a/README.md b/README.md index a24323b1cdc..b064104f196 100644 --- a/README.md +++ b/README.md @@ -67,23 +67,25 @@ For more information on inaccuracies, see issue 1. Create a personal access token (not the default GitHub Actions token) using the instructions [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). + Don't use the fine-grained tokens, instead use the classsic ones, as those + are what these docs were created with in mind. Personal access token must have permissions: `read:user` and `repo`. Copy the access token when it is generated – if you lose it, you will have to regenerate the token. - Some users are reporting that it can take a few minutes for the personal access token to work. For more, see [#30](https://github.com/jstrieb/github-stats/issues/30). -2. Create a copy of this repository by clicking +3. Create a copy of this repository by clicking [here](https://github.com/jstrieb/github-stats/generate). Note: this is **not** the same as forking a copy because it copies everything fresh, without the huge commit history. -3. Go to the "Secrets" page of your copy of the repository. If this is the +4. Go to the "Secrets" page of your copy of the repository. If this is the README of your copy, click [this link](../../settings/secrets/actions) to go to the "Secrets" page. Otherwise, go to the "Settings" tab of the newly-created repository and go to the "Secrets" page (bottom left). -4. Create a new secret with the name `ACCESS_TOKEN` and paste the copied +5. Create a new secret with the name `ACCESS_TOKEN` and paste the copied personal access token as the value. -5. It is possible to change the type of statistics reported by adding other +6. It is possible to change the type of statistics reported by adding other repository secrets. - To ignore certain repos, add them (in owner/name format e.g., `jstrieb/github-stats`) separated by commas to a new secret—created as @@ -100,15 +102,15 @@ For more information on inaccuracies, see issue information about private repositories. If you're not worried about that, you can change the values directly [in the Actions workflow itself](https://github.com/jstrieb/github-stats/blob/05de1314b870febd44d19ad2f55d5e59d83f5857/.github/workflows/main.yml#L48-L53). -6. Go to the [Actions +7. Go to the [Actions Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run Workflow" on the right side of the screen to generate images for the first time. - The images will be automatically regenerated every 24 hours, but they can be regenerated manually by running the workflow this way. -7. Take a look at the images that have been created in the +8. Take a look at the images that have been created in the [`generated`](generated) folder. -8. To add your statistics to your GitHub Profile README, copy and paste the +9. To add your statistics to your GitHub Profile README, copy and paste the following lines of code into your markdown content. Change the `username` value to your GitHub username. ```md @@ -119,9 +121,9 @@ For more information on inaccuracies, see issue ![](https://raw.githubusercontent.com/username/github-stats/master/generated/languages.svg#gh-dark-mode-only) ![](https://raw.githubusercontent.com/username/github-stats/master/generated/languages.svg#gh-light-mode-only) ``` -9. Link back to this repository so that others can generate their own +10. Link back to this repository so that others can generate their own statistics images. -10. Star this repo if you like it! +11. Star this repo if you like it! # Support the Project