UNPKG

2.65 kBMarkdownView Raw
1apemanmodule
2==========
3
4<!---
5This file is generated by ape-tmpl. Do not update manually.
6--->
7
8<!-- Badge Start -->
9<a name="badges"></a>
10
11[![Build Status][bd_travis_shield_url]][bd_travis_url]
12[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
13[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
14[![npm Version][bd_npm_shield_url]][bd_npm_url]
15
16[bd_repo_url]: https://github.com/apeman-labo/apemanmodule
17[bd_travis_url]: http://travis-ci.org/apeman-labo/apemanmodule
18[bd_travis_shield_url]: http://img.shields.io/travis/apeman-labo/apemanmodule.svg?style=flat
19[bd_license_url]: https://github.com/apeman-labo/apemanmodule/blob/master/LICENSE
20[bd_codeclimate_url]: http://codeclimate.com/github/apeman-labo/apemanmodule
21[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-labo/apemanmodule.svg?style=flat
22[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-labo/apemanmodule.svg?style=flat
23[bd_gemnasium_url]: https://gemnasium.com/apeman-labo/apemanmodule
24[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-labo/apemanmodule.svg
25[bd_npm_url]: http://www.npmjs.org/package/apemanmodule
26[bd_npm_shield_url]: http://img.shields.io/npm/v/apemanmodule.svg?style=flat
27[bd_bower_badge_url]: https://img.shields.io/bower/v/apemanmodule.svg?style=flat
28
29<!-- Badge End -->
30
31
32<!-- Description Start -->
33<a name="description"></a>
34
35Directory module index for apeman.
36
37<!-- Description End -->
38
39
40<!-- Overview Start -->
41<a name="overview"></a>
42
43
44
45<!-- Overview End -->
46
47
48<!-- Sections Start -->
49<a name="sections"></a>
50
51<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
52
53<a name="section-doc-guides-01-installation-md"></a>
54Installation
55-----
56
57```bash
58$ npm install apemanmodule --save
59```
60
61
62<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
63
64<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
65
66<a name="section-doc-guides-02-usage-md"></a>
67Usage
68---------
69
70```javascript
71/**
72 * This is an example index.js for a module directory.
73 */
74"use strict";
75
76const apemanmodule = require('apemanmodule');
77
78let index = apemanmodule(__dirname);
79
80// Print module settings.
81index.print();
82
83module.exports(index);
84```
85
86
87<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
88
89
90<!-- Sections Start -->
91
92
93<!-- LICENSE Start -->
94<a name="license"></a>
95
96License
97-------
98This software is released under the [MIT License](https://github.com/apeman-labo/apemanmodule/blob/master/LICENSE).
99
100<!-- LICENSE End -->
101
102
103<!-- Links Start -->
104<a name="links"></a>
105
106Links
107------
108
109+ [apeman](https://www.npmjs.com/package/apeman)
110
111<!-- Links End -->