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

Commit b2b75df

Browse files
committed
docs: update readme
1 parent 277325e commit b2b75df

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
A simple CLI for working with conventional commits.
44

5+
To get started, download the latest release and install it in your PATH.
6+
7+
Once installed, all you have to do is run in a repo with added changes:
8+
```sh
9+
git ce
10+
```
11+
512
## TODO
613
- [x] Add scoping
7-
- [ ] Add git config support for scopes and custom types
14+
- [x] Add git config support for scopes and custom types
15+
- [ ] Add documentation for custom project scopes

0 commit comments

Comments
 (0)