1 | apeman-util
|
2 | ======
|
3 |
|
4 |
|
5 | [![Build Status][my_travis_badge_url]][my_travis_url]
|
6 | [![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
|
7 | [![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
|
8 | [![dependencies][my_gemnasium_badge_url]][my_gemnasium_url]
|
9 | [![npm version][my_npm_budge_url]][my_npm_url]
|
10 | [![Git tip][my_gittip_budge_url]][my_gittip_url]
|
11 |
|
12 |
|
13 |
|
14 | Utilitiy modules for apeman.
|
15 |
|
16 |
|
17 |
|
18 |
|
19 | <a href="https://github.com/tick-tack/apeman"><img style="height:40px;" src="https://raw.githubusercontent.com/tick-tack/apeman/master/doc/images/apeman.png" height="40"></a>
|
20 | <a href="http://nodejs.org/"><img style="height:40px;" src="http://nodejs.org/images/logos/nodejs-dark.png" height="40"></a>
|
21 |
|
22 |
|
23 |
|
24 | Table of Contents
|
25 | -----
|
26 | - [Requirements](#02-requirements)
|
27 | - [Installation](#03-installation)
|
28 | - [Documents](#04-documents)
|
29 | - [Donation](#10-donation)
|
30 | - [License](#11-license)
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | <a name="02-requirements"></a>
|
36 | Requirements
|
37 | ------
|
38 |
|
39 | + [node.js][nodejs_url]
|
40 |
|
41 |
|
42 | <a name="03-installation"></a>
|
43 | Installation
|
44 | ------
|
45 |
|
46 | Install apeman-tasks via npm.
|
47 |
|
48 | ```bash
|
49 | $ npm install apeman-util --save
|
50 | ```
|
51 |
|
52 | <a name="04-documents"></a>
|
53 | Documents
|
54 | ------
|
55 | + [API Guide][my_apiguide_url]
|
56 | + [Coverage Report][my_coverage_report_url]
|
57 |
|
58 |
|
59 | <a name="10-donation"></a>
|
60 | Donation
|
61 | ------
|
62 |
|
63 | Support this project and [others by okunishinishi][my_gittip_url] via [gittip][my_gittip_url].
|
64 |
|
65 | [<img src="https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png" alt="Support via Gittip"/>][my_gittip_url]
|
66 |
|
67 |
|
68 | <a name="11-license"></a>
|
69 | License
|
70 | -------
|
71 | This software is released under the [MIT License][my_license_url].
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 | [nodejs_url]: http://nodejs.org/
|
79 | [my_license_url]: http://raw.github.com/tick-tack/apeman-util/master/LICENSE
|
80 | [my_travis_url]: http://travis-ci.org/tick-tack/apeman-util
|
81 | [my_travis_badge_url]: http://img.shields.io/travis/tick-tack/apeman-util.svg?style=flat
|
82 | [my_codeclimate_url]: http://codeclimate.com/github/tick-tack/apeman-util
|
83 | [my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/tick-tack/apeman-util.svg?style=flat
|
84 | [my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/tick-tack/apeman-util.svg?style=flat
|
85 | [my_apiguide_url]: http://tick-tack.github.io/apeman-util/apiguide/
|
86 | [my_coverage_report_url]: http://tick-tack.github.io/apeman-util/coverage/lcov-report/
|
87 | [my_gittip_url]: http://www.gittip.com/okunishinishi/
|
88 | [my_gittip_budge_url]: http://img.shields.io/gittip/okunishinishi.svg?style=flat
|
89 | [my_npm_url]: http://www.npmjs.org/package/apeman-util
|
90 | [my_npm_budge_url]: http://img.shields.io/npm/v/apeman-util.svg?style=flat
|
91 | [my_tag_url]: http://github.com/tick-tack/apeman-util/releases/tag/
|
92 | [my_tag_badge_url]: http://img.shields.io/github/tag/tick-tack/apeman-util.svg?style=flat
|
93 | [my_gemnasium_url]: http://gemnasium.com/tick-tack/apeman-util
|
94 | [my_gemnasium_badge_url]: http://img.shields.io/gemnasium/tick-tack/apeman-util.svg?style=flat
|
95 |
|
96 |
|
\ | No newline at end of file |