Skip to content

Commit 31c1b96

Browse files
committed
move the docs from the wiki to the codebase/repo
1 parent ca1e0e6 commit 31c1b96

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/API.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## API
2+
3+
If you'd like to access tickgit information about public `git` repositories, you can use our API.
4+
5+
### TODOs
6+
7+
`GET` requests to `https://tickgit.augmentable.dev/todos` with the `repo` query param populated with the URL of a git repo, like so:
8+
9+
```
10+
https://tickgit.augmentable.dev/todos?repo=https://github.com/facebook/react
11+
```
12+
Will return a simple JSON response:
13+
14+
```
15+
{"todos":125}
16+
```
17+
18+
Indicating the total count of TODOs found in the `HEAD` of that repository.
19+
20+
_more coming soon!_
21+
22+
### TODOs Badge
23+
24+
Similarly, `GET` requests to `https://tickgit.augmentable.dev/todos-badge` with the same `repo` query param:
25+
26+
```
27+
http://tickgit.augmentable.dev/todos-badge?repo=https://github.com/facebook/react
28+
```
29+
30+
Will return JSON that can be fed into a shields.io badge: [https://shields.io/endpoint](https://shields.io/endpoint)

0 commit comments

Comments
 (0)