You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
iotcat
e1db515f56
|
5 years ago | |
|---|---|---|
| .. | ||
| doc | 5 years ago | |
| fixture | 5 years ago | |
| .npmignore | 5 years ago | |
| .travis.yml | 5 years ago | |
| LICENSE | 5 years ago | |
| README.md | 5 years ago | |
| example.js | 5 years ago | |
| help-me.js | 5 years ago | |
| package.json | 5 years ago | |
| test.js | 5 years ago | |
README.md
help-me
Help command for node, to use with minimist and commist.
Example
'use strict'
var helpMe = require('help-me')
var help = helpMe({
// the default
dir: path.join(path.dirname(require.main.filename), 'doc'),
// the default
ext: '.txt'
})
help
.createStream(['hello']) // can support also strings
.pipe(process.stdout)
// little helper to do the same
help.toStdout(['hello']
Usage with commist
Commist provide a command system for node.
var commist = require('commist')()
var help = require('help-me')()
commist.register('help', help.toStdout)
commist.parse(process.argv.splice(2))
Acknowledgements
This project was kindly sponsored by nearForm.
License
MIT