Skip to content

Commit 2345c5f

Browse files
committed
Updated README.md
- Updated section about GitHub API rate limits - Updated roadmap
1 parent 232cd73 commit 2345c5f

File tree

1 file changed

+8
-45
lines changed

1 file changed

+8
-45
lines changed

README.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -25,59 +25,22 @@ Start command palette (with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> or <kb
2525
}
2626
```
2727

28-
### Authenticated GitHub API Requests
28+
## GitHub API Rate Limits
2929

3030
This extension makes API calls to the [GitHub REST API](https://docs.github.com/en/rest) which are subject to [rate limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).
3131

32-
By default, requests sent to the GitHub REST API are unauthenticated. Although the rate limit for unauthenticated requests is low, this should usually not be an issue because of caching and the most likely infrequent usage of this extension.
32+
By default, requests sent to the GitHub REST API are unauthenticated. Although the rate limit for unauthenticated requests is low, this should usually not be an issue because of caching and the typical infrequent usage of this extension.
3333

34-
If you reach the rate limit (e.g. because you work inside a corporate network), you can switch to [authenticated requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#authentication) by setting the `GITHUB_AUTHORIZATION` environment variable.
35-
36-
#### Examples
37-
38-
Using a [personal access token](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#oauth2-token-sent-in-a-header):
39-
40-
export GITHUB_AUTHORIZATION='Token <oauth2-token>'
41-
code
42-
43-
Using an [OAuth2 key/secret](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#oauth2-keysecret)
44-
45-
export GITHUB_AUTHORIZATION='Basic <base65-encoded-key-secret>'
46-
code
34+
If you reach the rate limit (e.g. because you work inside a corporate network), the extension will ask you if you want to the Authenticaton Provider for GitHub. If you agree, the extension will use authenticated GitHub API calls, which come with a mich higher rate limit than unauthenticated calls.
4735

4836

4937
## Roadmap
5038

51-
### v0.1
52-
- Basic implementation that allows to pull a single `.gitignore` file
53-
54-
### v0.2
55-
- Add language support for `.gitignore` files
56-
57-
### v0.3
58-
- Support reading `.gitignore` files from subdirectories in the github/gitignore repository
59-
60-
### v0.4
61-
- Support adding multiple `.gitignore` files and merge it to a `.gitignore` file
62-
63-
### v0.5
64-
- Support proxy
65-
66-
### v0.6
67-
- Update extension to more recent vscode ecosystem
68-
- Update dependencies
69-
70-
### v0.7
71-
- Support multi-root workspaces (see contribution by @hangxingliu)
72-
73-
### v0.8
74-
- Fix bugs
75-
- Remove `github` dependency
76-
- Update dependencies
77-
7839
### v0.x
79-
- Switch to async/await
80-
- Further improve proxy support
40+
- Implement logging accroding to best practices
41+
- Replace `https-proxy-agent` package by high level `proxy-agent` package
42+
- Switch to fetch API (requires vscode v1.82)
43+
- Further test and improve proxy support
8144
- Add unit tests with active proxy
8245

8346

@@ -88,7 +51,7 @@ See [CHANGELOG.md](CHANGELOG.md)
8851

8952
## License
9053

91-
See [LICENSE](LICENSE) file
54+
See [LICENSE](LICENSE)
9255

9356

9457
## Credits

0 commit comments

Comments
 (0)