summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcel Müller <neikos@neikos.email>2023-04-29 17:17:39 +0200
committerMarcel Müller <neikos@neikos.email>2023-04-29 17:22:30 +0200
commit5ff9e37e8d419f378378e62f64a50ec21060b188 (patch)
tree8335320064c80f40a9f5ecba422a5b8893ebe202
parent67eff07d05dba2b91f0d9242c5c171a279876ede (diff)
Update README to mention the new init behaviour
Signed-off-by: Marcel Müller <neikos@neikos.email>
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5543a2e..939b7e0 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,23 @@ Changelog management tool for CLI.
`cargo-changelog` is a merge-friendly changelog management utility.
+## Getting Started
+
+⚠️ `cargo-changelog` is still in alpha and will change and evolve. Do not use it
+unless you are ready to, potentially manually, upgrade configuration and/or
+templates on a regular basis.
+
+With that out of the way, to get started with `cargo-changelog` is to install it,
+and running `cargo changelog init`.
+
+If you are running this on a new project, you are good to go and can directly
+start building and adding changelog entries.
+
+If you are planning to use `cargo-changelog` on an already ongoing project,
+your old CHANGELOG.md will have moved to `.changelogs/suffix.md` and will be
+appended to the generated changelog. Be sure to update it so that it can
+seamlessly integrate with the generated one.
+
## Usage
`cargo-changelog` is a tool to generate and manage changelog entries.
@@ -52,6 +69,15 @@ optional metadata fields to your changelog entries. You can also specify a
template file that gets used when rendering your changelogs to your final
`CHANGELOG.md` file.
+### Suffix
+
+If you wish to add something to the CHANGELOG that gets appended to the end of
+the file, you can create a `suffix.md` in your changelog directory (per default
+`.changelogs`).
+
+This is also where the `cargo changelog init` moves your existing CHANGELOG.md
+if you had one while running the command.
+
## Current state
This project is in pre-alpha.