<commit_before>Katip
=========

This is a Change Logging gem for a git initialized project.

Planned to design a rake which dumps the change log as a list grouped by version tags. Log rows will contain links to commits, commit note and contributer name.

## Installation

To install Katip just use:

gem install katip

When using bundler put it in your Gemfile:

```ruby
source 'https://rubygems.org'

gem 'katip'
```

## Usage

In your git initialized project directory simply run

```sh
  % rake katip:create
  Create CHANGELOG.md
```

and that's it. You have a CHANGELOG.md file generated based on your git commits and created release tags.

#### Links to resources

* Disqussion http://stackoverflow.com/questions/7387612/git-changelog-how-to-get-all-changes-up-to-a-specific-tag
* Example bash https://github.com/kandanapp/kandan/blob/master/gen-changelog.sh
* Example output https://github.com/kandanapp/kandan/blob/master/CHANGELOG.md
* https://github.com/pcreux/pimpmychangelog this repo add support github issue and authors
<commit_msg>#7 Organize readme, add usage for daktilo<commit_after>Katip
=========

This is a Change Logging gem for a git initialized project.

Katip is a gem which dumps the change log as a list grouped by version tags.
It also has an executable ruby file **daktilo**, which can be used in any git project.
Log rows will contain links to commits, commit note and contributer name.

## Installation

To install Katip just use:

gem install katip

When using bundler put it in your Gemfile:

```ruby
source 'https://rubygems.org'

gem 'katip'
```

## Usage

In your git initialized project directory simply run

# Using the executable
```sh
  % daktilo
  Create CHANGELOG.md
```


# Using as a rake
Add gem in your Gemfile:

```ruby
source 'https://rubygems.org'

gem 'katip'
```

```sh
  % rake katip:create
  Create CHANGELOG.md
```

and that's it. You have a CHANGELOG.md file on project root, generated based on your git commits and created release tags.

#### Links to resources

* Disqussion http://stackoverflow.com/questions/7387612/git-changelog-how-to-get-all-changes-up-to-a-specific-tag
* Example bash https://github.com/kandanapp/kandan/blob/master/gen-changelog.sh
* Example output https://github.com/kandanapp/kandan/blob/master/CHANGELOG.md
* https://github.com/pcreux/pimpmychangelog this repo add support github issue and authors

{'fraction_non_alphanumeric': 0.0999580008399832, 'fraction_numerical': 0.00629987400251995, 'mean_word_length': 4.235164835164835, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2905241', 'n_tokens_mistral': 803, 'n_tokens_neox': 756, 'n_words': 275}