apeman-proto-abstract/README.md

apeman-proto-abstract
==========
<!---
!!DO NOT MANUALLY EDIT THIS FILE.

Generated by coz on 2016-05-08,
from a template provided by apeman-bud-readme.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/apeman-proto-labo/apeman-proto-abstract
[bd_travis_url]: http://travis-ci.org/apeman-proto-labo/apeman-proto-abstract
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-proto-labo/apeman-proto-abstract.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-proto-labo/apeman-proto-abstract
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-proto-labo/apeman-proto-abstract.svg?token=
[bd_license_url]: https://github.com/apeman-proto-labo/apeman-proto-abstract/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-proto-labo/apeman-proto-abstract
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-proto-labo/apeman-proto-abstract.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-proto-labo/apeman-proto-abstract.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-proto-labo/apeman-proto-abstract
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-proto-labo/apeman-proto-abstract.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-proto-abstract
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-proto-abstract.svg?style=flat
[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-proto-abstract.svg?style=flat

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Abstract prototype for all apeman projects.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>


<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

```bash
$ npm install apeman-proto-abstract --save
```

<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

```javascript
'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $proto: [
    // Inherit abstract project.
    require('apeman-proto-abstract')
  ],
  $tmpls: { /* ... */ },
  $tasks: { /* ... */ }
}

```

<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Defined.md.hbs" Start -->

<a name="section-doc-guides-03-defined-md"></a>
## Apemanfile Configurations

 + [$pkg](#apdoc-pkg)
 + [$needs](#apdoc-needs)

<a name="apdoc-pkg"></a>
### $pkg

| Name | Value |
| --- | ---- |
| name | apeman-proto-abstract |
| version | 4.0.0 |
| description | Abstract prototype for all apeman projects. |

<a name="apdoc-needs"></a>
### $needs

| Bin | How to install |
| --- | ----- |
| **apeman** | `npm install -g apeman` |


<!-- Section from "doc/guides/03.Defined.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-proto-labo/apeman-proto-abstract/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman](http://github.com/apeman-labo/apeman)
+ [apeman-proto](https://github.com/apeman-cmd-labo/apeman-proto)

<!-- Links End -->