Skip to content

Commit 3481c8c

Browse files
committed
docs: Update README with Ko-fi button and task list
1 parent 1f02d64 commit 3481c8c

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
⚠️ **EDUCATIONAL PURPOSE ONLY** ⚠️
44
This project is a reverse-engineered implementation of the GitHub Copilot API created for educational purposes only. It is not officially supported by GitHub and should not be used in production environments.
55

6+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E519XS7W)
7+
68
## Project Overview
79

810
A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools like AI assistants, local interfaces, and development utilities.
@@ -56,14 +58,14 @@ npx copilot-api --port 8080
5658

5759
The following command line options are available:
5860

59-
| Option | Description | Default | Alias |
60-
| ------------ | --------------------------------------------- | ------- | ----- |
61-
| --port | Port to listen on | 4141 | -p |
62-
| --verbose | Enable verbose logging | false | -v |
63-
| --business | Use a business plan GitHub account | false | none |
64-
| --manual | Enable manual request approval | false | none |
65-
| --rate-limit | Rate limit in seconds between requests | none | -r |
66-
| --wait | Wait instead of error when rate limit is hit | false | -w |
61+
| Option | Description | Default | Alias |
62+
| ------------ | -------------------------------------------- | ------- | ----- |
63+
| --port | Port to listen on | 4141 | -p |
64+
| --verbose | Enable verbose logging | false | -v |
65+
| --business | Use a business plan GitHub account | false | none |
66+
| --manual | Enable manual request approval | false | none |
67+
| --rate-limit | Rate limit in seconds between requests | none | -r |
68+
| --wait | Wait instead of error when rate limit is hit | false | -w |
6769

6870
Example usage:
6971

@@ -123,6 +125,6 @@ This helps you control usage and monitor requests in real-time.
123125

124126
- [ ] Manual authentication flow
125127
- [x] Manual request approval system
126-
- [ ] Rate limiting implementation
128+
- [x] Rate limiting implementation
127129
- [x] Token counting
128130
- [x] Enhanced error handling and recovery

0 commit comments

Comments
 (0)