Browse Source

Basic README stub

Getty Ritter 6 years ago
parent
commit
630df40fb9
1 changed files with 7 additions and 0 deletions
  1. 7 0
      README.md

+ 7 - 0
README.md

@@ -0,0 +1,7 @@
+**Bunyan** is a work-in-progress tool for guiding and facilitating
+`CHANGELOG` generation from `git log` output. Lots of tools exist that
+do this in an automatic way: however, Bunyan does not want to simply
+generate a changelog _for_ you; instead, it's a tool for walking `git
+log` output and asking you to categorize or ignore each commit, then
+rearranging and formatting those commit messages in a way that is more
+amenable to reading by an end-user.