Name	Last modified	Size	Description
	Parent Directory		-
	doc/	2023-06-15 18:18	-
	fixture/	2023-06-15 18:18	-
	LICENSE	1985-10-26 08:15	1.1K
	example.js	1985-10-26 08:15	160
	help-me.js	1985-10-26 08:15	2.2K
	package.json	2023-06-15 18:21	1.6K
	test.js	1985-10-26 08:15	5.1K
	README.md	1985-10-26 08:15	917	d7c1522 post receive test [كارل مبارك]

help-me
=======

Help command for node, to use with [minimist](http://npm.im/minimist) and [commist](http://npm.im/commist).

Example
-------

```js
'use strict'

var helpMe = require('help-me')
var path = require('path')
var help = helpMe({
  dir: path.join(__dirname, '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](http://npm.im/commist) provide a command system for node.

```js
var commist = require('commist')()
var path = require('path')
var help = require('help-me')({
  dir: path.join(__dirname, 'doc')
})

commist.register('help', help.toStdout)

commist.parse(process.argv.splice(2))
```

Acknowledgements
----------------

This project was kindly sponsored by [nearForm](http://nearform.com).

License
-------

MIT