1 | apeman-srch
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
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-cmd-labo/apeman-srch
|
17 | [bd_travis_url]: http://travis-ci.org/apeman-cmd-labo/apeman-srch
|
18 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-cmd-labo/apeman-srch.svg?style=flat
|
19 | [bd_license_url]: https://github.com/apeman-cmd-labo/apeman-srch/blob/master/LICENSE
|
20 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-cmd-labo/apeman-srch
|
21 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-cmd-labo/apeman-srch.svg?style=flat
|
22 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-cmd-labo/apeman-srch.svg?style=flat
|
23 | [bd_gemnasium_url]: https://gemnasium.com/apeman-cmd-labo/apeman-srch
|
24 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-cmd-labo/apeman-srch.svg
|
25 | [bd_npm_url]: http://www.npmjs.org/package/apeman-srch
|
26 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-srch.svg?style=flat
|
27 | [bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-srch.svg?style=flat
|
28 |
|
29 |
|
30 |
|
31 |
|
32 |
|
33 | <a name="description"></a>
|
34 |
|
35 | Plugin search for apeman.
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 | <a name="overview"></a>
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 | <a name="sections"></a>
|
50 |
|
51 |
|
52 |
|
53 | <a name="section-doc-readme-01-installation-md"></a>
|
54 | Installation
|
55 | -----
|
56 |
|
57 | Install apeman-srch module via [npm][npm_url].
|
58 | ```bash
|
59 | $ npm install apeman-srch -g
|
60 | ```
|
61 |
|
62 |
|
63 | [npm_url]: https://www.npmjs.com/
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 | <a name="section-doc-readme-02-usage-md"></a>
|
70 | Usage
|
71 | ---------
|
72 |
|
73 | ```bash
|
74 | $ apeman-srch -t task "nodeunit"
|
75 | ```
|
76 |
|
77 |
|
78 | ##### CLI Options
|
79 |
|
80 | ```bash
|
81 | $ apeman-srch -h
|
82 |
|
83 | Usage: apeman-srch [options] [term...]
|
84 |
|
85 | Plugin search for apeman.
|
86 |
|
87 | Options:
|
88 |
|
89 | -h, --help output usage information
|
90 | -V, --version output the version number
|
91 | -v, --verbose Show verbose logs
|
92 | -t, --type Type to search.
|
93 |
|
94 | Examples:
|
95 |
|
96 | $ apeman-srch # List all available packages.
|
97 | $ apeman-srch -t task # List all available task packages.
|
98 | $ apeman-srch -t task "foo" # List all available task wich match term "foo".
|
99 |
|
100 |
|
101 | ```
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 | <a name="section-doc-readme-03-programmatic-a-p-i-md"></a>
|
109 | Programmatic API
|
110 | ---
|
111 |
|
112 | apeman-srch also provide programmatic API.
|
113 |
|
114 | Firstly, install the module locally.
|
115 |
|
116 | ```bash
|
117 | $ npm install apeman-srch --save-dev
|
118 | ```
|
119 |
|
120 | Then,
|
121 |
|
122 | ```javascript
|
123 | var apemanSrch = require('apeman-srch');
|
124 |
|
125 | apemanSrch({
|
126 | task: "mocha"
|
127 | }, function (err) {
|
128 | /*...*/
|
129 | });
|
130 | ```
|
131 |
|
132 |
|
133 | ##### Programmatic Options
|
134 |
|
135 | | Key | Description | Default |
|
136 | | --- | ----------- | ------- |
|
137 | | verbose | Show verbose logs | |
|
138 | | type | Type to search. | |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 |
|
148 | <a name="license"></a>
|
149 |
|
150 | License
|
151 | -------
|
152 | This software is released under the [MIT License](https://github.com/apeman-cmd-labo/apeman-srch/blob/master/LICENSE).
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 | <a name="links"></a>
|
159 |
|
160 | Links
|
161 | ------
|
162 |
|
163 | + [apeman](http://github.com/apeman-labo/apeman)
|
164 | + [apeman-cmd-labo](http://github.com/apeman-cmd-labo)
|
165 |
|
166 |
|