Skip to content

Commit

Permalink
Updating readme with output example
Browse files Browse the repository at this point in the history
  • Loading branch information
mtdowling committed Aug 10, 2014
1 parent f1429a0 commit bca8ff7
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,16 @@ Creates an annotated git tag from a changelog entry.
./chag tag -f CHANGELOG.rst
./chag tag --message "{date}" CHANGELOG.rst
./chag tag --message "Release code name" CHANGELOG.rst

Executing ``chag tag`` will have output similar to the following:

::

./chag tag --debug CHANGELOG.rst
Parsed the 0.0.1 changelog entry from CHANGELOG.rst:
tag: 0.0.1, date: 2014-09-10, tmpfile: /var/folders/2d//T/tag-0.0.1.XXXXXXXXXX.QjNa2HSO
Running git tag -a -F /var/folders/2d//T/tag-0.0.1.XXXXXXXXXX.QjNa2HSO
[SUCCESS] Tagged the 0.0.1 release
Tagged 0.0.1 with the following annotation:

Initial release.

0 comments on commit bca8ff7

Please sign in to comment.