git_changelog_generator 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bca35e43e3be5cf41bec7f61ef9ded108675ede
-  data.tar.gz: 4da00bb8161a9125d27b3f6f798c5e065c489169
+  metadata.gz: 83e1d6c1b9cc9e5f2a87b71816dca59bb0f88dda
+  data.tar.gz: 9ff40fef542c6b2ead044bd1c1bb667ecfb26a57
 SHA512:
-  metadata.gz: 91ff23301670dca5afbb51d6cf36b78fb7b9e9f1be696db7f09c797021fa4de95d677ca2f184b2f1a38b8419c31021a440528f6096ba6be4f85eb5d0035009c4
-  data.tar.gz: bdb864e96868c33aa71e263a01f184788f6f63234fcc38a402183c1da2c54b3a6667df0d8f2123b0dc9d20b4c88a40869b7c7710633f5fb604bacabb876b66d0
+  metadata.gz: 29809f6248ec70ae78713914fc1e297fc5142e657c51267dbf3b51c1a619e071869f96b9faa1e50acd3514e0677d5e376ceddbc6fb812d453b268ce8e4902b38
+  data.tar.gz: 7ecd5698da97d38ad0ad4541559233cf0eaf6c0f12665dabfc15d41e69322fdeefbcaa32a9066bf52797c7261290978ce36d9f36dad9f1fe631eeacee1c6f0a3

data/README.md

@@ -1,8 +1,9 @@
 # GitChangelogGenerator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git_changelog_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/git_changelog_generator.svg)](https://badge.fury.io/rb/git_changelog_generator)
 
-TODO: Delete this and the text above, and describe your gem
+This gem creates a changelog file based on your git version history. The output is categorized by tags. Even if no tags
+are available in the repository the gem will still work using the HEAD as virtual tag.
 
 ## Installation
 
@@ -22,7 +23,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Just run the following command in a directory maintained by git
+
+```
+chlog create [filename]
+```
+
+where filename is the filename of the created file. If no argument is specified the file will be created under `changelog.txt`.
 
 ## Development
 
@@ -37,5 +44,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
 

data/git_changelog_generator.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{This is a gem for creating changelogs from git version history.}
   spec.description   = %q{This is a gem for creating changelogs from git version history.}
-  spec.homepage      = "http://github.com"
+  spec.homepage      = "https://github.com/appcom-interactive/changelog_generator"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/lib/git_changelog_generator/version.rb

@@ -1,3 +1,3 @@
 module GitChangelogGenerator
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Stefan Neidig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,7 @@ files:
 - git_changelog_generator.gemspec
 - lib/git_changelog_generator.rb
 - lib/git_changelog_generator/version.rb
-homepage: http://github.com
+homepage: https://github.com/appcom-interactive/changelog_generator
 licenses:
 - MIT
 metadata: