Skip to content

Commit a7b63eb

Browse files
changed README
Signed-off-by: Sachin Panayil <[email protected]>
1 parent 4b79e53 commit a7b63eb

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ The following guide is for members of the project team who have access to the re
4141
### Prerequisites
4242

4343
- Python 3.x
44-
- GitHub API access token (optional, but recommended for higher rate limits)
44+
- GitHub Personal Access Token (optional, but highly recommended for higher rate limits)
45+
> **_Create a PAT:_** GitHub -> Settings -> Developer Settings -> Personal Access Tokens
4546
4647
### Installation
4748

@@ -56,10 +57,11 @@ cd codejson-index-generator
5657
pip install PyGithub
5758
```
5859

59-
3. Set up your GitHub API token _(optional but recommended)_:
60+
1. Set up your GitHub Personal Access Token:
6061
```bash
6162
export GITHUB_KEY="your-token-here"
6263
```
64+
> **_NOTE:_** _Use of GitHub PAT is highly recommened due to rate limiting._
6365
6466
### Usage
6567

@@ -69,7 +71,7 @@ The script can be run from the command line with the following options:
6971
python main.py --agency AGENCY_NAME --orgs "org1,org2" --output code.json --version VERSION_NUMBER
7072
```
7173

72-
_Seperate organizations by comma without any spaces!_
74+
> **_NOTE:_** _Seperate organizations by comma without any spaces!_
7375
7476
##### Required arguments:
7577
- `--agency`: The name of your agency
@@ -81,9 +83,8 @@ _Seperate organizations by comma without any spaces!_
8183

8284
##### Example:
8385
```bash
84-
python main.py --agency CMS --orgs "DSACMS,CMSgov,CMS-Enterprise" --output code.json --version 1.0.0
86+
python3 main.py --agency CMS --orgs "DSACMS,CMSgov,CMS-Enterprise" --output code.json --version 1.0.0
8587
```
86-
_The "python" keyword may be different depending on what version you have installed. (e.g. python3)_
8788

8889
## Coding Style and Linters
8990

0 commit comments

Comments
 (0)