Skip to content

Commit

Permalink
Add readme, yargs instead of optimist
Browse files Browse the repository at this point in the history
  • Loading branch information
rnijveld committed Oct 3, 2014
1 parent 4908a83 commit bb5b49f
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# dazeus-nodejs-util
Utility functions for dazeus bindings.

## Helper functions
Some helper functions are provided, please take a look at the source for detailed documentation of
these:

dazeus.optionsFromArgv(argv)

dazeus.yargs()

dazeus.help(argv)

dazeus.readFile(file)

dazeus.writeFile(file, data)

dazeus.existsIn(file, str)

dazeus.randomFrom(file)

dazeus.removeFrom(file, str)

dazeus.appendTo(file, str)

dazeus.firstArgument(args)

dazeus.isCommand(command, args, yes[, no])
2 changes: 1 addition & 1 deletion dazeus-util.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ module.exports.yargs = function () {
*/
module.exports.help = function (argv) {
if (argv.help) {
optimist.showHelp();
yargs.showHelp();
process.exit();
}
};
Expand Down

0 comments on commit bb5b49f

Please sign in to comment.