Added a minimal readme.

Author: coordt

Makefile

@@ -50,8 +50,8 @@ endif
 	generate-changelog
 	$(call EDIT_CHANGELOG)
 	export BRANCH_NAME=$(SHORT_BRANCH_NAME);bumpversion $(BUMPVERSION_OPTS) $(RELEASE_KIND) --allow-dirty
-	#git push origin $(BRANCH_NAME)
-	#git push --tags
+	git push origin $(BRANCH_NAME)
+	git push --tags
 
 set-release-kind-major:
 	$(eval RELEASE_KIND := major)

README.md

@@ -0,0 +1,42 @@
+# Generate Changelog
+
+Use your commit log to make a beautiful changelog file.
+
+## Features
+
+- Configurable to adapt to your changelog preferences.
+- Filter out commits and tags based on regular expression matching.
+- Classify commit messages into sections such as "New", "Fixes", and "Changes".
+- Templated using [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) templates.
+- Rewrite commit summary or commit body using pipelines of actions.
+- Supports your merge or rebase workflows and complicated git histories.
+- Supports full or incremental changelog generation.
+- Parses [trailers key values](https://zerokspot.com/weblog/2020/10/24/git-commit-messages-with-attributes/)
+- Supports of multi-authors for one commit through configurable [trailers key values](https://git.wiki.kernel.org/index.php/CommitMessageConventions)
+
+## Requirements
+
+Python 3.8 or higher.
+
+## Installation
+
+```bash
+$ pip install generate-changelog
+```
+
+
+## Usage
+
+Create a default configuration file.
+
+```bash
+$ generate-changelog --generate-config
+```
+
+This creates a file named `.changelog-config.yaml`. You can make changes to the default configuration.
+
+Generate your changelog via:
+
+```bash
+$ generate-changelog
+```