Skip to content
Browse files

Edited README.md via GitHub

  • Loading branch information...
1 parent e43ecce commit 83bf0b7f7ff81ae76b7936c7348db3f948787d1a @dpup committed Mar 29, 2011
Showing with 5 additions and 0 deletions.
  1. +5 −0 README.md
View
5 README.md
@@ -29,6 +29,11 @@ Then on the command line:
node example.js --name='Your Name' --age 43 --height=1.234 --pets=fred,bob --hobby biking --hobby=snowboarding
+## Passing Flags
+
+ * Flag names should be prefixed with two dashes: e.g. `--flagname`
+ * Values can be separated from the name with either an equal sign or a space: e.g. `--flagname=flagvalue` or `--flagname flagvalue`
+ * Additional non-flag arguments can be passed by adding `--` before the subsequent args. The remaining args will be returned from `flags.parse()` as an array, e.g. `--one --two -- other stuff here`
## Defining Flags

0 comments on commit 83bf0b7

Please sign in to comment.
Something went wrong with that request. Please try again.