Skip to content

Commit ece7748

Browse files
committed
Improve README
1 parent 5bcdd6b commit ece7748

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,16 @@ You can change the personal information, experience, education, social media, ce
101101

102102
You will find `git_data_fetcher.mjs` file in the main directory of the repository. This file is used to fetch the data (Pull requests, Issues, Organizations, Pinned projects etc.) from your github.
103103

104-
In the project you will see a `env.example` file, rename it to `.env`. In that file, you will see the following environment variables
104+
In the project you will see a `env.example` file, create a new file named `.env` and copy contents of `env.example` into it. In that file, you will see the following environment variables
105105

106106
```javascript
107107
GITHUB_TOKEN = your_token;
108108
GITHUB_USERNAME = your_username;
109109
```
110110

111-
You can get a github token as described [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). Give all permissions while generating token. Also add your `githubUserName` in the correct field inside `git_data_fetcher.mjs`.
112-
Now, you need to run following command.
111+
You can get a github token as described [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). Give all permissions while generating token. Add your github username and the token generated in `GITHUB_USERNAME` and `GITHUB_TOKEN` variables in the .env file.
112+
113+
Now, you need to run following command. (Make sure you executed `npm install` before this)
113114

114115
**Warning:** Treat your tokens like passwords and keep them secret. When working with the API, use tokens as environment variables instead of hardcoding them into your programs.
115116

0 commit comments

Comments
 (0)