Skip to content
This repository was archived by the owner on Apr 12, 2021. It is now read-only.

Commit 954eae4

Browse files
committed
Update README.md
1 parent f897e39 commit 954eae4

File tree

1 file changed

+39
-15
lines changed

1 file changed

+39
-15
lines changed

README.md

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,54 @@ Stats related to weekly contributions to GitHub repositories
44
## Authentication
55
App is required to be authenticated to GitHub api in order to retrieve stats about repositories. You need to provide your personal authentication token from GitHub. GitHub personal token can generated at https://github.com/settings/tokens
66

7-
#### Request Query String Parameter
7+
#### Query String Parameter
88
#### ``?token=YOUR-GITHUB-TOKEN``
9-
Attach ``token`` parameter with your GitHub personal token to query string of url
9+
Attach ``token`` parameter with your GitHub personal token to query string of url.
1010

11-
#### Request Header
11+
``
12+
curl "https://links.vizydrop.com/github/vizydrop?token=YOUR-GITHUB-TOKEN"
13+
``
1214

13-
#### Header: ``Authorization: token YOUR-GITHUB-TOKEN``
14-
Attach authorization header ``Authorization`` to your request in the following format ``token YOU-GITHUB-TOKEN``
15+
#### Header
1516

17+
#### ``Authorization: YOUR-GITHUB-TOKEN``
18+
Attach authorization header ``Authorization`` to your request with your GitHub token
19+
20+
``
21+
curl -v -H "Authorization: YOUR-GITHUB-TOKEN" "https://links.vizydrop.com/github/vizydrop"
22+
``
1623
## API
1724

18-
#### Retrieve stats of repositories where you are added as collaborator
19-
#### ``GET: /me``
2025

21-
#### Retrieve stats of repositories by organization
22-
#### ``GET: /:organization``
23-
- ``:organization`` is organization at github. For example ``vizydrop``
26+
#### GET: /me
27+
Retrieve stats of repositories where you are added as collaborator
28+
29+
``
30+
curl "https://links.vizydrop.com/github/me?token=YOUR-GITHUB-TOKEN"
31+
``
32+
33+
#### GET: /:organization
34+
Retrieve stats of repositories by organization
35+
- ``:organization`` is organization at github.
2436

25-
#### Retrieve stats of concrete repository
26-
#### ``GET: /:owner/:repository``
37+
``
38+
curl "https://links.vizydrop.com/github/vizydrop?token=YOUR-GITHUB-TOKEN"
39+
``
40+
41+
#### GET: /:owner/:repository
42+
Retrieve stats of concrete repository
2743
- ``:owner`` is user or organization at github
2844
- ``:repository`` is name of the repository
2945

30-
#### Retrieve stats of repositories by team
31-
#### ``GET: /:organization/team/:team``
46+
``
47+
curl "https://links.vizydrop.com/github/vizydrop/github-data-link?token=YOUR-GITHUB-TOKEN"
48+
``
49+
50+
#### GET: /:organization/team/:team
51+
Retrieve stats of repositories by team
3252
- ``:organization`` is organization at github. For example ``vizydrop``
33-
- ``:team`` is team name or slug at github. For example ``core``
53+
- ``:team`` is team name or slug at github. For example ``core``
54+
55+
``
56+
curl "https://links.vizydrop.com/github/vizydrop/team/core?token=YOUR-GITHUB-TOKEN"
57+
``

0 commit comments

Comments
 (0)