Skip to content

Commit 5d46f72

Browse files
authored
docs: update README (#42)
1 parent 5ac4ec6 commit 5d46f72

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# `git-draft(1)` [![CI](https://github.com/mtth/git-draft/actions/workflows/ci.yaml/badge.svg)](https://github.com/mtth/git-draft/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/mtth/git-draft/graph/badge.svg?token=3OTKAI0FP6)](https://codecov.io/gh/mtth/git-draft) [![Pypi badge](https://badge.fury.io/py/git-draft.svg)](https://pypi.python.org/pypi/git-draft/)
22

33
> [!NOTE]
4-
> WIP: Not quite functional yet.
4+
> WIP: Unstable API.
5+
56

67
## Highlights
78

8-
* Concurrent edits. Continue editing while the assistant runs, without any
9-
risks of interference.
10-
* Customizable prompt templates
11-
* Extensible bot API
9+
* Concurrent edits.
10+
* Customizable prompt templates.
11+
* Extensible bot API.
12+
13+
14+
## Installation
15+
16+
```sh
17+
pipx install git-draft[openai]
18+
```

0 commit comments

Comments
 (0)