From f105d93c14c58be55eb8ba625fbb852f9ffe849d Mon Sep 17 00:00:00 2001 From: Jeremy Wall Date: Tue, 13 Feb 2018 17:47:52 -0600 Subject: [PATCH] Add usage documentation to the readme. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2f5a84..cc86801 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,29 @@ be version controlled, enforce _some_ typesafety, and output configuration for any application regardless of that applications preferred format. -## Examples +## Usage + +You can get ucg with cargo `cargo install ucg`. + +Running ucg help will show the following output. + +```sh +Universal Configuration Grammar compiler. + +USAGE: + ucg [SUBCOMMAND] + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +SUBCOMMANDS: + build Compile a specific ucg file. + help Prints this message or the help of the given subcommand(s) + validate Check a specific ucg file for errors. +``` + +## Language Examples #### Base Types