From 04e96c0c6b8bb92fba62bcc5a080e7727ad3edfd Mon Sep 17 00:00:00 2001 From: Alex Flint Date: Sat, 31 Oct 2015 18:48:38 -0700 Subject: udpate readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d45a31f..f3db6c9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -Argument parsing for Go. +# Argument parsing for Go ```golang +import "github.com/alexflint/go-arg" + var args struct { Foo string Bar bool @@ -16,7 +18,7 @@ hello True ``` -Setting defaults values: +### Default values ```golang var args struct { @@ -27,7 +29,7 @@ args.Foo = "default value" arg.MustParse(&args) ``` -Marking options as required +### Marking options as required ```golang var args struct { @@ -37,7 +39,7 @@ var args struct { arg.MustParse(&args) ``` -Positional argument: +### Positional argument ```golang var args struct { @@ -56,7 +58,7 @@ Input: src.txt Output: [x.out y.out z.out] ``` -Usage strings: +### Usage strings ```bash $ ./example -h usage: [--verbose] [--dataset DATASET] [--optimize OPTIMIZE] [--help] INPUT [OUTPUT [OUTPUT ...]] @@ -73,7 +75,7 @@ options: --help, -h print this help message ``` -Options with multiple values: +### Options with multiple values ``` var args struct { Database string -- cgit v1.2.3