From 6c1e749e3fd8049deb79531cb51bf7934c8664c3 Mon Sep 17 00:00:00 2001 From: Philippe Creux Date: Thu, 25 Aug 2011 09:43:06 -0700 Subject: [PATCH] Add README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db5b792 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +## Pimp My Changelog + +Add links to users and issues in your CHANGELOG.md. + +### Example: + +> Add Travis-CI support. (@pcreux, #181) + +becomes: + +> Add Travis-CI support. ([@pcreux][], [#181][]) + +[#181]: https://github.com/gregbell/active_admin/issues/181 +[@pcreux]: https://github.com/pcreux + + +### Usage: + +Install: + + gem install pimpmychangelog + +Run: + + pimpmychangelog gregbell active_admin CHANGELOG.md + # => Pimped CHANGELOG.md +