From b7e6ebf36e2ac4314e6bff65f1d64466ea82a18a Mon Sep 17 00:00:00 2001
From: Jimmi Holst Christensen
Date: Tue, 10 Nov 2020 18:53:57 +0100
Subject: Deprecate ComptimeClap in favor of parseEx

---
 README.md | 56 ++------------------------------------------------------
 1 file changed, 2 insertions(+), 54 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ebcebbb..3156539 100644
--- a/README.md
+++ b/README.md
@@ -99,59 +99,7 @@ zig-clap/example/simple-error.zig:16:18: note: called from here
     _ = args.flag("--helps");
 ```
 
-### `ComptimeClap`
-
-The `ComptimeClap` is the parser used by `clap.parse`. It allows the user to use a custom argument
-iterator.
-
-```zig
-const std = @import("std");
-const clap = @import("clap");
-
-const debug = std.debug;
-
-pub fn main() !void {
-    const allocator = std.heap.page_allocator;
-
-    // First we specify what parameters our program can take.
-    // We can use `parseParam` to parse a string to a `Param(Help)`
-    const params = comptime [_]clap.Param(clap.Help){
-        clap.parseParam("-h, --help             Display this help and exit.              ") catch unreachable,
-        clap.parseParam("-n, --number <NUM>     An option parameter, which takes a value.") catch unreachable,
-        clap.parseParam("-s, --string <STR>...  An option parameter which can be specified multiple times.") catch unreachable,
-        clap.parseParam("<POS>...") catch unreachable,
-    };
-    const Clap = clap.ComptimeClap(clap.Help, clap.args.OsIterator, &params);
-
-    // We then initialize an argument iterator. We will use the OsIterator as it nicely
-    // wraps iterating over arguments the most efficient way on each os.
-    var iter = try clap.args.OsIterator.init(allocator);
-    defer iter.deinit();
-
-    // Initalize our diagnostics, which can be used for reporting useful errors.
-    // This is optional. You can also just pass `null` to `parser.next` if you
-    // don't care about the extra information `Diagnostics` provides.
-    var diag: clap.Diagnostic = undefined;
-
-    // Parse the arguments
-    var args = Clap.parse(allocator, &iter, &diag) catch |err| {
-        // Report useful error and exit
-        diag.report(std.io.getStdErr().outStream(), err) catch {};
-        return err;
-    };
-    defer args.deinit();
-
-    if (args.flag("--help"))
-        debug.warn("--help\n", .{});
-    if (args.option("--number")) |n|
-        debug.warn("--number = {}\n", .{n});
-    for (args.options("--string")) |s|
-        debug.warn("--string = {}\n", .{s});
-    for (args.positionals()) |pos|
-        debug.warn("{}\n", .{pos});
-}
-
-```
+There is also a `parseEx` variant that takes an argument iterator.
 
 ### `StreamingClap`
 
@@ -222,7 +170,7 @@ pub fn main() !void {
 
 ```
 
-Currently, this parse is the only parser that allow an array of `Param` that
+Currently, this parse is the only parser that allow an array of `Param` tha
 is generated at runtime.
 
 ### `help`
-- 
cgit v1.2.3