1 | askconfig
|
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 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
16 |
|
17 | [bd_repo_url]: https://github.com/okunishinishi/node-askconfig
|
18 | [bd_travis_url]: http://travis-ci.org/okunishinishi/node-askconfig
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-askconfig.svg?style=flat
|
20 | [bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-askconfig
|
21 | [bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-askconfig.svg?token=
|
22 | [bd_license_url]: https://github.com/okunishinishi/node-askconfig/blob/master/LICENSE
|
23 | [bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-askconfig
|
24 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-askconfig.svg?style=flat
|
25 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-askconfig.svg?style=flat
|
26 | [bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-askconfig
|
27 | [bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-askconfig.svg
|
28 | [bd_npm_url]: http://www.npmjs.org/package/askconfig
|
29 | [bd_npm_shield_url]: http://img.shields.io/npm/v/askconfig.svg?style=flat
|
30 | [bd_standard_url]: http://standardjs.com/
|
31 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 | <a name="description"></a>
|
38 |
|
39 | Node.js module to ask for configuration via interactive shell
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 | <a name="sections"></a>
|
48 |
|
49 |
|
50 |
|
51 | <a name="section-doc-guides-01-installation-md"></a>
|
52 | Installation
|
53 | -----
|
54 |
|
55 | ```bash
|
56 | npm install askconfig --save
|
57 | ```
|
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 | <a name="section-doc-guides-02-usage-md"></a>
|
64 | Usage
|
65 | -----
|
66 |
|
67 | ```javascript
|
68 | #!/usr/bin/env node
|
69 | 'use strict'
|
70 |
|
71 | const askconfig = require('askconfig')
|
72 |
|
73 | askconfig({
|
74 | name: 'default-name',
|
75 | description: ''
|
76 | }).then((result) => {
|
77 | if (err) {
|
78 | console.error(err)
|
79 | process.exit(1)
|
80 | } else {
|
81 | console.log(`Result: ${result}`)
|
82 | process.exit(0)
|
83 | }
|
84 | })
|
85 |
|
86 |
|
87 | ````
|
88 |
|
89 |
|
90 | <!-- Section from "doc/guides/02.Usage.md.hbs" End -->
|
91 |
|
92 |
|
93 | <!-- Sections Start -->
|
94 |
|
95 |
|
96 | <!-- LICENSE Start -->
|
97 | <a name="license"></a>
|
98 |
|
99 | License
|
100 | -------
|
101 | This software is released under the [MIT License](https://github.com/okunishinishi/node-askconfig/blob/master/LICENSE).
|
102 |
|
103 | <!-- LICENSE End -->
|
104 |
|
105 |
|
106 |
|
\ | No newline at end of file |