apeman-task-wiki

apeman-task-wiki
==========

[![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]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-task-labo/apeman-task-wiki
[bd_travis_url]: http://travis-ci.org/apeman-task-labo/apeman-task-wiki
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-task-labo/apeman-task-wiki.svg?style=flat
[bd_license_url]: https://github.com/apeman-task-labo/apeman-task-wiki/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-task-labo/apeman-task-wiki
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-task-labo/apeman-task-wiki.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-task-labo/apeman-task-wiki.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-task-labo/apeman-task-wiki
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-task-labo/apeman-task-wiki.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-task-wiki
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-task-wiki.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

apeman task to push github wiki.

Running this task cause:

1. Clone GitHub wiki project into temporary directory.
2. Copy files from main repo in to the cloned wiki repo.
3. Commit and push the cloned wiki repo.
4. Cleanup the cloned wiki repo.

Installation
-----

``bash
$ npm install apeman-task-wiki --save-dev
`


Usage
---------

1. Define a task within Apemanfile.js
2. Call the task via apeman task command.

Apemanfile.js
`javascript
/* This is an example Apemanfile to use apeman-task-wiki /

'use strict'

module.exports = {
$pkg: { / ... / },
$tasks: {
// Define your own task.
'wiki:push': require('apeman-task-wiki')('./doc/wiki', {
//Options
})
}
}

`

Then,
`bash
$ apeman task wiki:push
``

Signature
-------

#### define(src, options) -> function

apeman task to push github wiki.

##### Args

| Name | Type | Default | Description |
| --- | ---- | --- | --- |
| src | string | | Source file name pattern. |
| options | object | | Optional settings. |
| options.msg | string | | Message for commit. |
| options.tmp | string | | Tmp directory path. |
| options.url | string | | Wiki url. Auto detect unless specified. |

License
-------
This software is released under the MIT License.

Links
------

+ apeman
+ apeman-task-labo