From 3f5bbb306242cee407b6793fadfbe938d8f0c8f6 Mon Sep 17 00:00:00 2001 From: Jarryd Beck Date: Tue, 31 Oct 2017 18:19:15 +1100 Subject: [PATCH] update the readme --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 355417e..10c0393 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,12 @@ Any type can be given as long as it can be parsed, with operator>>. To parse the command line do: - options.parse(argc, argv); + auto result = options.parse(argc, argv); -To retrieve an option use `options.count("option")` to get the number of times +To retrieve an option use `result.count("option")` to get the number of times it appeared, and - options["opt"].as() + result["opt"].as() to get its value. If "opt" doesn't exist, or isn't of the right type, then an exception will be thrown. @@ -93,9 +93,7 @@ This is a header only library. The only build requirement is a C++ compiler that supports C++11 regular expressions. For example GCC >= 4.9 or clang with libc++. - # TODO list * Allow unrecognised options. * Various help strings. -* Unicode aware for help strings.