Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
veged committed Apr 11, 2012
1 parent df0745b commit 19a3063
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
@@ -1,13 +1,23 @@
# Command-Option-Argument # Command-Option-Argument


COA is a yet another parser for command line options. COA is a parser for command line options that aim to get maximum profit from formalization your program API.
You can choose one of the [existing modules](https://github.com/joyent/node/wiki/modules#wiki-parsers-commandline), Once you write definition in terms of commands, options and arguments you automaticaly get:
or write your own like me. * Command line help text

* Program API for use COA-based programs as modules
## Features * Shell completion


* Program API for use COA-based programs as modules (experimantal) Other features:
* Shell completion (experimantal) * Rich types for options and arguments, such as arrays, boolean flags and required
* Commands can be async throught using promising (powered by [Q](https://github.com/kriskowal/q))
* Easy submoduling some existing commands to new top-level one
* Combined validation and complex parsing of values

TODO:
* Localization
* Shell-mode
* Configs
* Aliases
* Defaults


## Examples ## Examples


Expand Down Expand Up @@ -55,7 +65,7 @@ exports.COA = function() {
}; };
```` ````


## API ## API reference


### Cmd ### Cmd
Command is a top level entity. Commands may have options and arguments. Command is a top level entity. Commands may have options and arguments.
Expand Down Expand Up @@ -299,11 +309,3 @@ Set custom additional completion for current argument.<br>
#### Arg.end #### Arg.end
Finish chain for current option and return parent command instance.<br> Finish chain for current option and return parent command instance.<br>
**@returns** *COA.Cmd* `parent` command **@returns** *COA.Cmd* `parent` command


## TODO
* Localization
* Shell-mode
* Configs
* Aliases
* Defaults

0 comments on commit 19a3063

Please sign in to comment.