6 files changed, 51 insertions, 35 deletions

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 40fe612..08d791f 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -7,7 +7,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v2.4.0
         with:
           submodules: recursive
       - uses: goto-bus-stop/setup-zig@v1.3.0
@@ -17,7 +17,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v2.4.0
       - uses: goto-bus-stop/setup-zig@v1.3.0
         with:
           version: master
diff --git a/README.md b/README.md
index 197eb4c..d6ad7a0 100644
--- a/README.md
+++ b/README.md
@@ -180,21 +180,25 @@ const clap = @import("clap");
 const std = @import("std");
 
 pub fn main() !void {
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
+        clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
+    };
+
+    var args = try clap.parse(clap.Help, &params, .{});
+    defer args.deinit();
+
     // clap.help is a function that can print a simple help message, given a
     // slice of Param(Help). There is also a helpEx, which can print a
     // help message for any Param, but it is more verbose to call.
-    try clap.help(
-        std.io.getStdErr().writer(),
-        comptime &.{
-            clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
-            clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
-        },
-    );
+    if (args.flag("--help"))
+        return clap.help(std.io.getStdErr().writer(), &params);
 }
 
 ```
 
 ```
+$ zig-out/bin/help --help
         -h, --help      Display this help and exit.
         -v, --version   Output version information and exit.
 ```
@@ -218,22 +222,26 @@ const clap = @import("clap");
 const std = @import("std");
 
 pub fn main() !void {
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help       Display this help and exit.              ") catch unreachable,
+        clap.parseParam("-v, --version    Output version information and exit.     ") catch unreachable,
+        clap.parseParam("    --value <N>  An option parameter, which takes a value.") catch unreachable,
+    };
+
+    var args = try clap.parse(clap.Help, &params, .{});
+    defer args.deinit();
+
     // clap.usage is a function that can print a simple usage message, given a
     // slice of Param(Help). There is also a usageEx, which can print a
     // usage message for any Param, but it is more verbose to call.
-    try clap.usage(
-        std.io.getStdErr().writer(),
-        comptime &.{
-            clap.parseParam("-h, --help       Display this help and exit.              ") catch unreachable,
-            clap.parseParam("-v, --version    Output version information and exit.     ") catch unreachable,
-            clap.parseParam("    --value <N>  An option parameter, which takes a value.") catch unreachable,
-        },
-    );
+    if (args.flag("--help"))
+        return clap.usage(std.io.getStdErr().writer(), &params);
 }
 
 ```
 
 ```
+$ zig-out/bin/usage --help
 [-hv] [--value <N>]
 ```
 
diff --git a/clap/streaming.zig b/clap/streaming.zig
index 885c581..3f24aaa 100644
--- a/clap/streaming.zig
+++ b/clap/streaming.zig
@@ -46,7 +46,7 @@ pub fn StreamingClap(comptime Id: type, comptime ArgIterator: type) type {
         pub fn next(parser: *@This()) !?Arg(Id) {
             switch (parser.state) {
                 .normal => return try parser.normal(),
-                .chaining => |state| return try parser.chainging(state),
+                .chaining => |state| return try parser.chaining(state),
                 .rest_are_positional => {
                     const param = parser.positionalParam() orelse unreachable;
                     const value = (try parser.iter.next()) orelse return null;
@@ -89,7 +89,7 @@ pub fn StreamingClap(comptime Id: type, comptime ArgIterator: type) type {
 
                     return parser.err(arg, .{ .long = name }, error.InvalidArgument);
                 },
-                .short => return try parser.chainging(.{
+                .short => return try parser.chaining(.{
                     .arg = arg,
                     .index = 0,
                 }),
@@ -110,7 +110,7 @@ pub fn StreamingClap(comptime Id: type, comptime ArgIterator: type) type {
             }
         }
 
-        fn chainging(parser: *@This(), state: State.Chaining) !?Arg(Id) {
+        fn chaining(parser: *@This(), state: State.Chaining) !?Arg(Id) {
             const arg = state.arg;
             const index = state.index;
             const next_index = index + 1;
diff --git a/example/README.md.template b/example/README.md.template
index 74a2f1d..1848d03 100644
--- a/example/README.md.template
+++ b/example/README.md.template
@@ -74,6 +74,7 @@ program can take.
 ```
 
 ```
+$ zig-out/bin/help --help
         -h, --help      Display this help and exit.
         -v, --version   Output version information and exit.
 ```
@@ -97,6 +98,7 @@ of the help message.
 ```
 
 ```
+$ zig-out/bin/usage --help
 [-hv] [--value <N>]
 ```
 
diff --git a/example/help.zig b/example/help.zig
index d90373a..de3b707 100644
--- a/example/help.zig
+++ b/example/help.zig
@@ -2,14 +2,17 @@ const clap = @import("clap");
 const std = @import("std");
 
 pub fn main() !void {
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
+        clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
+    };
+
+    var args = try clap.parse(clap.Help, &params, .{});
+    defer args.deinit();
+
     // clap.help is a function that can print a simple help message, given a
     // slice of Param(Help). There is also a helpEx, which can print a
     // help message for any Param, but it is more verbose to call.
-    try clap.help(
-        std.io.getStdErr().writer(),
-        comptime &.{
-            clap.parseParam("-h, --help     Display this help and exit.         ") catch unreachable,
-            clap.parseParam("-v, --version  Output version information and exit.") catch unreachable,
-        },
-    );
+    if (args.flag("--help"))
+        return clap.help(std.io.getStdErr().writer(), &params);
 }
diff --git a/example/usage.zig b/example/usage.zig
index 90fa310..368a6b3 100644
--- a/example/usage.zig
+++ b/example/usage.zig
@@ -2,15 +2,18 @@ const clap = @import("clap");
 const std = @import("std");
 
 pub fn main() !void {
+    const params = comptime [_]clap.Param(clap.Help){
+        clap.parseParam("-h, --help       Display this help and exit.              ") catch unreachable,
+        clap.parseParam("-v, --version    Output version information and exit.     ") catch unreachable,
+        clap.parseParam("    --value <N>  An option parameter, which takes a value.") catch unreachable,
+    };
+
+    var args = try clap.parse(clap.Help, &params, .{});
+    defer args.deinit();
+
     // clap.usage is a function that can print a simple usage message, given a
     // slice of Param(Help). There is also a usageEx, which can print a
     // usage message for any Param, but it is more verbose to call.
-    try clap.usage(
-        std.io.getStdErr().writer(),
-        comptime &.{
-            clap.parseParam("-h, --help       Display this help and exit.              ") catch unreachable,
-            clap.parseParam("-v, --version    Output version information and exit.     ") catch unreachable,
-            clap.parseParam("    --value <N>  An option parameter, which takes a value.") catch unreachable,
-        },
-    );
+    if (args.flag("--help"))
+        return clap.usage(std.io.getStdErr().writer(), &params);
 }