docs(README): update the README to reflect new features

2026-06-14 14:31:57 +02:00
parent 5aa382a4c9
commit 88c77f8ac6
3 changed files with 261 additions and 4 deletions
@@ -1,11 +1,40 @@
 # jj-cz: Conventional Commits for Jujutsu

-An interactive CLI tool that guides Jujutsu users through creating
-[conventional commit](https://www.conventionalcommits.org/) messages.
+<h1 align="center">Bakit</h1>
+<div align="center">
+ <strong>
+    An interactive CLI tool that guides Jujutsu users through creating <a href="https://www.conventionalcommits.org/" rel="noopener">conventional commit</a> messages.
+ </strong>
+</div>
+<br/>
+
+<div align="center">
+  <!-- CI -->
+  <a href="https://labs.phundrak.com/phundrak/jj-cz/actions?workflow=action.yml&branch=develop">
+    <img src="https://labs.phundrak.com/phundrak/jj-cz/actions/workflows/action.yml/badge.svg?branch=develop" alt="actions status" />
+  </a>
+  <!-- Crates.io -->
+  <a href="https://crates.io/crates/sqlx">
+    <img src="https://img.shields.io/crates/v/jj-cz.svg" alt="Crates.io version"/>
+  </a>
+  <!-- License -->
+  <a href="#license">
+    <img src="https://img.shields.io/badge/License-MIT-blue" alt="MIT License" />
+  </a>
+  <a href="#license">
+    <img src="https://img.shields.io/badge/License-GPL--3.0--or--later-blue" alt="GPL License" />
+  </a>
+  <!-- Tools -->
+  <a href="https://www.gnu.org/software/emacs/" target="_blank">
+    <img src="https://img.shields.io/badge/Made%20with-GNU%2FEmacs-blueviolet.svg?logo=GNU%20Emacs&logoColor=white" alt="Made with GNU/Emacs" />
+  </a>
+</div>
+
+[![demo](assets/demo.gif)](assets/demo.cast)

 ## Features

- Interactive prompts for type, scope, and description
+- Interactive prompts for type, scope, breaking changes, and description
 - All 11 commit types with descriptions (feat, fix, docs, style,
  refactor, perf, test, build, ci, chore, revert)
 - Optional scope with validation
@@ -28,12 +57,23 @@ You can also set the revision message of a few revisions at once, or
 target a single revision other than the current one.

 ```sh
-jj-cz @- xs develop
+jj-cz @- xs develop # assuming the revision xs and the bookmark develop exist
 ```

 No explicit revision is simply the equivalent of `jj-cz @`, like
 `jj desc`.

+If you want to create a new revision after calling `jj-cz` on a single
+revision, you can use the `-n` or `--new` flag.
+
+```sh
+jj-cz -n # equivalent of `jj-cz && jj new`
+jj-cz xs -n # equivalent of `jj-cz xs && jj new`
+jj-cz -n xs # equivalent of `jj-cz xs && jj new`
+```
+
+You cannot, however, call `jj-cz` on multiple revisions with the `--new` flag active.
+
 ## Requirements

 - A Jujutsu repository
@@ -93,3 +133,30 @@ Just make sure Rust is available on your machine (duh!).
 ```sh
 cargo install --path .
 ```
+
+## Tips and questions
+### Running `jj cz` instead of `jj-cz`
+
+I do not actually use `jj-cz`, but `jj cz`. I just find it more
+natural to treat it as its own jj subcommand. To achieve that, you can
+simply add an alias to your jujutsu configuration.
+```toml
+[aliases]
+cz = ["utils", "exec", "--", "jj-cz"]
+```
+
+### `$EDITOR` and editing the revision’s body message
+
+`jj-cz` relies on your `$EDITOR` variable to open a temporary file in
+which you’ll write the body of your commit. This body does not include
+some footers `jj-cz` may include by itself, such as the breaking
+change footer.
+
+In some cases, you may not notice a new editor open. In this case,
+check whether you already have an editor open, the file might be
+there. In my case, if I already have an open Emacsclient, it will open
+there.
+
+## License
+
+This project is licensed under either the [MIT](LICENSE.MIT.md) or [GPL-3.0](LICENSE.GPL.md) licenses, as you prefer.