From 7eb7fef94f2443a8c880bf94371dfed151dce220 Mon Sep 17 00:00:00 2001
From: pyr0ball <pyroballpcs@gmail.com>
Date: Thu, 25 Jul 2019 19:36:52 -0700
Subject: [PATCH] added info to the changelog script

---
 scripts/changelog.sh | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/scripts/changelog.sh b/scripts/changelog.sh
index 51dc18a..509a169 100644
--- a/scripts/changelog.sh
+++ b/scripts/changelog.sh
@@ -1,2 +1,10 @@
 #!/bin/bash
+
+# Adapted from https://coderwall.com/p/5cv5lg/generate-your-changelogs-with-git-log
+#
+# Only commits tagged with #changelog will be added
+#
+# Usage: pass two tags in when running this script, and a changelog will be generated listing the differences between those two tags.
+# ex:
+# ./changelog.sh rev.2.0.1 rev.2.1.1
 git log ${1}...${2} --pretty=format:'<li> <a href="https://github.com/pyr0ball/pyr0piezo/commit/%H">view commit &bull;</a> %s</li> ' --reverse | grep "#changelog"