README.md in git-heatmap-0.1.0 vs README.md in git-heatmap-0.2.0
- old
+ new
@@ -1,35 +1,57 @@
-# Git::Heatmap
+# Git Heatmap
-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/heatmap`. To experiment with that code, run `bin/console` for an interactive prompt.
+Visualise git history over time.
-TODO: Delete this and the text above, and describe your gem
+[](http://travis-ci.org/ioquatix/build)
## Installation
-Add this line to your application's Gemfile:
+Install it:
-```ruby
-gem 'git-heatmap'
+ $ gem install build
+
+## Usage
+
```
+git-heatmap generate path/to/repository
+```
-And then execute:
+Open the resulting HTML file in a browser.
- $ bundle
+### Help
-Or install it yourself as:
+```
+git-heatmap --help
+```
- $ gem install git-heatmap
+## Contributing
-## Usage
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
-TODO: Write usage instructions here
+## License
-## Development
+Released under the MIT license.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
-## Contributing
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-heatmap.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.