Skip to content

Commit 61cf865

Browse files
authored
Update README.md
1 parent 04fceaa commit 61cf865

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,39 @@ Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organ
120120
* Save your changes.
121121
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
122122
* For Firefox: Reload the temporary add-on by going to `about:debugging`"This Firefox" → Click "Reload" next to your extension.
123-
4. **Get Customized SCRUM Reports**
124-
- The reports will now be generated using contributions from your organization.
123+
4. **How to Obtain a GitHub Personal Access Token**
125124

125+
- To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token.
126+
127+
#### Steps to Generate a Token
128+
129+
1. **Go to GitHub Developer Settings:**
130+
Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account.
131+
132+
2. **Choose Token Type:**
133+
- Select **"Personal access tokens (classic)"**.
134+
135+
3. **Generate a New Token:**
136+
- Click **"Generate new token"**.
137+
- Give your token a descriptive name (e.g., "Scrum Helper Extension").
138+
- Set an expiration date if desired.
139+
140+
4. **Create and Copy the Token:**
141+
- Click **"Generate token"** at the bottom.
142+
- **Copy the token** and save it securely. You will not be able to see it again!
143+
144+
5. **Paste the Token in Scrum Helper:**
145+
- Open the Scrum Helper extension popup.
146+
- Paste your token into the "GitHub Token" field.
147+
148+
> **Keep your token secret!** Never share it or commit it to public repositories.
149+
150+
**Why use a token?**
151+
GitHub tokens allow the extension to make authenticated requests, increasing your API rate limit and enabling access to private repositories if you grant those permissions.
152+
153+
---
154+
5. **Get Customized SCRUM Reports**
155+
- The reports will now be generated using contributions from your organization.
126156

127157
## About contributing
128158

0 commit comments

Comments
 (0)