example/iot-gateway/node_modules/aws-iot-device-sdk/node_modules/mqtt/node_modules/help-me/README.md

   1 help-me
   2 =======
   3
   4 Help command for node, to use with [minimist](http://npm.im/minimist) and [commist](http://npm.im/commist).
   5
   6 Example
   7 -------
   8
   9 ```js
  10 var helpMe = require('help-me')
  11
  12   , help   =helpMe({
  13     // the default
  14     dir: path.join(path.dirname(require.main.filename), 'doc')
  15     // the default
  16   , ext: '.txt'
  17 })
  18
  19 help
  20   .createStream(['hello']) // can support also strings
  21   .pipe(process.stdout)
  22
  23 // little helper to do the same
  24 help.helpToStdout(['hello']
  25 ```
  26
  27 Usage with commist
  28 ------------------
  29
  30 [Commist](http://npm.im/commist) provide a command system for node.
  31
  32 ```js
  33 var commist = require('commist')()
  34   , help    = require('./')()
  35
  36 commist.register('help', help.toStdout)
  37
  38 commist.parse(process.argv.splice(2))
  39 ```
  40
  41 Acknowledgements
  42 ----------------
  43
  44 This project was kindly sponsored by [nearForm](http://nearform.com).
  45
  46 License
  47 -------
  48
  49 MIT