Add an example of the changelog

knl · Jul 9, 2020 · 59a218e · 59a218e
1 parent dceb796
commit 59a218e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.adoc b/README.adoc
@@ -5,11 +5,14 @@ image:https://img.shields.io/github/v/release/knl/niv-updater-action[GitHub rele
 
 This action will open a pull request to master branch (or otherwise specified
 branch) whenever https://github.com/nmattia/niv[niv] detects updates to
-`nix/sources.json` in your repository, for each dependency separately.
+`nix/sources.json` in your repository, for each dependency separately. Each PR
+will contain a beautiful Changelog of all the changes in the update, like this:
 
-The idea is that you can set up a scheduled workflow with this action, and you
-would get new PRs whenever there are updates, so that you don't have to do that
-manually.
+image:./assets/niv-update-action-changelog.png[title="Changelog generated by niv-updater-action]
+
+The best way to use niv-updater-action is to set up a scheduled workflow. This
+way, whenever there are new updates, you will get a PR that you can just
+approve and avoid a lot of manual work.
 
 == Example
 

diff --git a/assets/niv-update-action-changelog.png b/assets/niv-update-action-changelog.png