<commit_before>= pgit

Describe your project here

:include:pgit.rdoc
<commit_msg>added usage and installation information<commit_after># PGit

## Example Usage

Assuming that:
  - you have a project that uses Pivotal Tracker and Git that is listed under ~/.pgit.rc.yml
  - your working directory is in that project,
  - you want to automatically branch out based on the story title
  - the story title with story id 10102004 is "Implement a really cool feature"

```
$ pgit story_branch -s 10102004
```

will create a branch for you named `implement-really-cool-feature-10102004`

## Installation

1. Install via RubyGems:

```
$ gem install pgit
```

2. Setup configuration file:

```
$ pgit install
```

This will generate a YAML file under `~/.pgit.rc.yml`. Edit that file to add information about projects that you're working on.  Each project needs a project `id`, Pivotal Tracker `api_token`, and `path`

{'fraction_non_alphanumeric': 0.08562019758507135, 'fraction_numerical': 0.02854006586169045, 'mean_word_length': 4.094972067039106, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '1148516', 'n_tokens_mistral': 298, 'n_tokens_neox': 269, 'n_words': 120}