Skip to content

Commit eea0dd7

Browse files
committed
docs: final updates for v1.0
1 parent 5e48236 commit eea0dd7

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44
<a href="https://dotfyle.com/plugins/chrisgrieser/nvim-tinygit">
55
<img alt="badge" src="https://dotfyle.com/plugins/chrisgrieser/nvim-tinygit/shield?style=flat"/></a>
66

7-
Bundle of commands focused on swift and streamlined git
8-
operations.
7+
Bundle of commands focused on swift and streamlined git operations.
8+
9+
## Breaking changes in v1.0
10+
- `dressing.nvim` and `nvim-notify` are **no longer dependencies**.
11+
- `telescope.nvim` is now a **required dependency**.
12+
- The `commit.insertIssuesOnHashSign` feature has been removed. Better issue
13+
insertion via plugins like [cmp-git](https://github.com/petertriho/cmp-git) or
14+
[blink-cmp-git](https://github.com/Kaiser-Yang/blink-cmp-git) now work there.
15+
- `smartCommit` was overhauled. Among other improvements, it now supports a
16+
commit body.
917

1018
> [!NOTE]
11-
> [Version 1.0 included several breaking changes.](#breaking-changes-in-v10) If
12-
> you want to keep using the previous version, pin the tag `v0.9`:
19+
> If you want to keep using the previous version, without these breaking
20+
> changes, you can pin the tag `v0.9`:
1321
>
1422
> ```lua
1523
> -- lazy.nvim
@@ -20,14 +28,6 @@ operations.
2028
> },
2129
> ```
2230
23-
## TODO for version 1.0 release
24-
- [x] commit message module
25-
- [x] update docs
26-
- [x] update issue template
27-
- [x] commit preview
28-
- [x] adaptive commit window height
29-
- [ ] use `telescope` instead of `vim.ui.select`
30-
3131
## Feature overview
3232
3333
<table>
@@ -71,7 +71,6 @@ operations.
7171
7272
<!-- toc -->
7373
74-
- [Breaking changes in v1.0](#breaking-changes-in-v10)
7574
- [Installation](#installation)
7675
- [Configuration](#configuration)
7776
- [Commands](#commands)
@@ -90,16 +89,6 @@ operations.
9089
9190
<!-- tocstop -->
9291
93-
## Breaking changes in v1.0
94-
- `dressing.nvim` and `nvim-notify` are **no longer dependencies**.
95-
- `telescope.nvim` is now an **always required dependency**.
96-
- The `commit.insertIssuesOnHashSign` feature has been removed. Since the commit
97-
creation window is now larger, better issue insertion via plugins like
98-
[cmp-git](https://github.com/petertriho/cmp-git) or
99-
[blink-cmp-git](https://github.com/Kaiser-Yang/blink-cmp-git) now work there.
100-
- `smartCommit` was overhauled. Among other improvements, it now supports a
101-
commit body.
102-
10392
## Installation
10493
**Requirements**
10594
- nvim 0.10+

0 commit comments

Comments
 (0)