Merge pull request #25 from chelnak/clarify_functionality_in_readme

Clarify functionality in README
chelnak · Apr 20, 2022 · 2b7a701 · 2b7a701
2 parents 6a10f19 + 91a46f9
commit 2b7a701
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,14 @@
 
 An opinionated [GitHub Cli](https://github.com/cli/cli) extension for creating changelogs that adhere to the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification.
 
+## What is supported?
+
+`gh-changelog` is the tool for you if:
+
+- You want to closely follow the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification
+- You are using tags to mark releases
+- You are following a pull-request workflow
+
 ## Installation and Usage
 
 Before you start make sure that: