Skip to content

Commit f5594c1

Browse files
committed
update badge docs
1 parent 4809ff1 commit f5594c1

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/API.md

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

33
### TODOs Badge
44

5-
`GET` requests to `https://api.tickgit.com/badgen` with a `repo` query param:
5+
`GET` requests to `https://api.tickgit.com/badgen` with a `repo` path segment:
66

77
```
88
https://api.tickgit.com/badgen/github.com/facebook/react
99
```
1010

11-
Supplying a `branch` param will lookup a specific branch.
11+
Supplying a `branch` segment will lookup a specific branch. `master` is the branch used if none is specified.
1212

1313
```
1414
https://api.tickgit.com/badgen/github.com/facebook/react/branch-name
1515
```
1616

1717
Will return JSON that can be fed into a badgen badge: [https://badgen.net/https](https://badgen.net/https)
1818

19+
```
20+
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/augmentable-dev/tickgit)](https://www.tickgit.com/browse?repo=github.com/augmentable-dev/tickgit)
21+
```
22+
1923
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/augmentable-dev/tickgit)](https://www.tickgit.com/browse?repo=github.com/augmentable-dev/tickgit)

0 commit comments

Comments
 (0)