Skip to content

Commit 03792a5

Browse files
committed
Update README
1 parent c5ba184 commit 03792a5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
![CI](https://github.com/grubersjoe/github-contributions-api/actions/workflows/test.yml/badge.svg)
44

5-
A simple API that returns number of GitHub contributions based on a users GitHub
6-
profile. This API is used by
5+
An API that returns the number of GitHub contributions by scraping a user's
6+
GitHub profile. This API is used by
77
[React GitHub Calendar](https://github.com/grubersjoe/react-github-calendar)
88
(React component).
99

@@ -30,7 +30,7 @@ Send a GET request to the API in the following format:
3030
https://github-contributions-api.jogruber.de/v4/GITHUB_USERNAME
3131
```
3232

33-
And you will receive an object with _complete_ history of that user's
33+
And you will receive an object with complete history of that user's
3434
contributions (total per year and for each day):
3535

3636
```json
@@ -93,7 +93,7 @@ https://github-contributions-api.jogruber.de/v4/GITHUB_USERNAME?format=nested
9393
}
9494
```
9595

96-
### The `y` query parameter
96+
### Query specific time frame
9797

9898
Use the `y` (year) query parameter to retrieve the data for a specific year, a
9999
set of years, the _last_ year (GitHub's default view), or the data for _all_

0 commit comments

Comments
 (0)