REciNK Component for {{ name|title }}
====================================

This is a [REciNK](https://github.com/MitocGroup/recink) component for {{ name|title }}.

# Prerequisites

- [x] Git >= v1.x
- [x] Node.js >= v6.x
- [x] NPM >= v3.x
- [x] [REciNK](https://github.com/MitocGroup/recink#installation)

> Use [nvm](https://github.com/creationix/nvm#installation) to install and
manage different versions of Node.js; Ideally, use v8+ for faster performance


# Installation

- `npm install -g recink-{{ name|lower }}`

> Note that the component is installed automatically when running `recink component add {{ name|lower }}`


# Configuration

`.recink.yml` configuration:

```yaml
$:
  preprocess:
    '$.{{ name|lower }}.name': 'eval'
  {{ name|lower }}:
    name: 'process.env.{{ name|upper }}'      # Name to output
```

`.travis.yml` configuration:

```yaml
script: 'recink run unit -c {{ name|lower }}'  
before_install:
  # other before_install scripts...
  - 'npm install -g recink-{{ name|lower }}'
```

Or using the registry: 

```yaml
before_install:
  # other before_install scripts...
  - 'recink component add {{ name|lower }}'
```

Add the `{{ name|upper }}` to `.travis.yml`:

```
recink travis encrypt -x '{{ name|upper }}="John"'
```

> If you are using [Travis Pro](https://travis-ci.com/) [read this guide](https://github.com/MitocGroup/recink/blob/master/docs/guide.md#configuring-github-project) to properly encrypt the environment variable


# Usage

```
{{ name|upper }}="John" recink run unit -c {{ name|lower }}
```

Or the generic way:

```
{{ name|upper }}="John" recink run {{ name|lower }}
```