Skip to content

Commit 4809ff1

Browse files
committed
update README
1 parent 8ffd270 commit 4809ff1

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ It's not meant to replace full-fledged project management tools such as JIRA or
1313

1414
### TODOs
1515

16-
`tickgit todos` will scan a codebase and identify any TODO items in the comments. It will output a report like so:
16+
`tickgit` will scan a codebase and identify any TODO items in the comments. It will output a report like so:
1717

1818
```
19-
# tickgit todos ~/Desktop/facebook/react
19+
# tickgit ~/Desktop/facebook/react
2020
...
2121
TODO:
2222
=> packages/scheduler/src/__tests__/SchedulerBrowser-test.js:85:9
@@ -37,7 +37,7 @@ TODO: useTransition hook instead.
3737
128 TODOs Found 📝
3838
```
3939

40-
Check out [an example](https://todos.tickg.it/?repo=https://github.com/kubernetes/kubernetes) of the TODOs tickgit will surface for the Kubernetes codebase.
40+
Check out [an example](https://www.tickgit.com/browse?repo=github.com/kubernetes/kubernetes) of the TODOs tickgit will surface for the Kubernetes codebase.
4141

4242
#### Coming Soon
4343

docs/API.md

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

33
### TODOs Badge
44

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

77
```
8-
https://api.tickgit.com/badge?repo=https://github.com/facebook/react
8+
https://api.tickgit.com/badgen/github.com/facebook/react
99
```
1010

11-
Supplying a `branch` query param will lookup a specific branch.
11+
Supplying a `branch` param will lookup a specific branch.
1212

13-
Will return JSON that can be fed into a shields.io badge: [https://shields.io/endpoint](https://shields.io/endpoint)
13+
```
14+
https://api.tickgit.com/badgen/github.com/facebook/react/branch-name
15+
```
16+
17+
Will return JSON that can be fed into a badgen badge: [https://badgen.net/https](https://badgen.net/https)
1418

15-
[![TODOs](https://img.shields.io/endpoint?url=https://api.tickgit.com/badge?repo=github.com/augmentable-dev/tickgit)](https://www.tickgit.com/browse?repo=github.com/augmentable-dev/tickgit)
19+
[![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)