<commit_before>[![Build Status](https://travis-ci.org/nanoc/nanoc-git.png)](https://travis-ci.org/nanoc/nanoc-git)

# nanoc-git

This provides a Git deployer for [nanoc](http://nanoc.ws).

Maintained by [lifepillar](https://github.com/lifepillar).

## Compatibility

Nanoc 4.0.0 or later.

## Installation

`gem install nanoc-git`

## Usage

Example configuration for the Git deployer:

```yaml
deploy:
  default:
    kind: git
    remote: <EMAIL>:myself/myproject.git
    branch: gh-pages
    forced: true
```

The following configuration options are available:

* `remote` (default `origin`): the Git remote to deploy to
* `branch` (default `master`): the Git branch to deploy
* `forced` (default `false`): Whether or not to push with `--force`

<commit_msg>Add more specific usage instructions.<commit_after>[![Build Status](https://travis-ci.org/nanoc/nanoc-git.png)](https://travis-ci.org/nanoc/nanoc-git)

# nanoc-git

This provides a Git deployer for [nanoc](http://nanoc.ws).

Maintained by [lifepillar](https://github.com/lifepillar).

## Compatibility

Nanoc 4.0.0 or later.

## Installation

`gem install nanoc-git`

## Usage

Require the gem by putting the following line in `lib/default.rb`:

```ruby
require 'nanoc-git'
```

Configure the gem by editing `nanoc.yaml`. Example configuration for the Git
deployer:

```yaml
deploy:
  default:
    kind: git
    remote: <EMAIL>:myself/myproject.git
    branch: gh-pages
    forced: true
```

The following configuration options are available:

* `remote` (defaults to `origin`): the Git remote to deploy to
* `branch` (defaults to `master`): the Git branch to deploy to
* `forced` (defaults to `false`): Whether or not to push with `--force`


{'fraction_non_alphanumeric': 0.14034057545507928, 'fraction_numerical': 0.0035231943628890195, 'mean_word_length': 4.179331306990881, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, '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': '4563985', 'n_tokens_mistral': 589, 'n_tokens_neox': 560, 'n_words': 173}