Skip to content

improve PAT instruction #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VardyNg wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improve PAT instruction #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,18 @@
npm i react-github-embed
```

Get your `Personal Access Token` by signing in to your github account and then go to your **setting -> developer setting -> Personal access tokens -> Generate new token**. Add it to `.env` file in the root directory.

```
REACT_APP_GITHUB_TOKEN = <YOUR_GITHUB_TOKEN>
```
### Personal Access Token (PAT) setup
As the package will make request to GitHub GraphQL API, a GitHub PAT is required to authenticate the requests.

1. Sign in to your GitHub Account
2. Go to [Settings](https://github.com/settings/profile) -> Developer Settings -> Personal access tokens -> [Token (classics)](https://github.com/settings/tokens)
3. Click "Generate new token" -> "Generate new Token (classic)"
4. Give the token a name and set Expiration Date, grant `public_repo` permission
5. Set environment variable with the token:

```
REACT_APP_GITHUB_TOKEN = <YOUR_GITHUB_TOKEN>
```

## Demo & Playground

Expand Down