Skip to content

Commit 02a983a

Browse files
include note about supplying a branch name
1 parent 31c1b96 commit 02a983a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Will return a simple JSON response:
1717

1818
Indicating the total count of TODOs found in the `HEAD` of that repository.
1919

20+
To supply a branch name, send a `branch` query param with your request.
21+
2022
_more coming soon!_
2123

2224
### TODOs Badge
@@ -27,4 +29,6 @@ Similarly, `GET` requests to `https://tickgit.augmentable.dev/todos-badge` with
2729
http://tickgit.augmentable.dev/todos-badge?repo=https://github.com/facebook/react
2830
```
2931

32+
The `branch` query param will also work as above.
33+
3034
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)