From 70b9230639cad36c54d19aae37ae890e44939cdf Mon Sep 17 00:00:00 2001 From: Jarryd Beck Date: Wed, 15 Nov 2017 17:56:25 +1100 Subject: [PATCH] fix changelog and readme add booleans into the changelog and the readme --- CHANGELOG.md | 1 + README.md | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50fc327..8b4ba45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ options. The project adheres to semantic versioning. * The function `ParseResult::arguments` returns a vector of the parsed arguments to iterate through in the order they were provided. * The symbol `cxxopts::version` for the version of the library. +* Booleans can be specified with various strings and explicitly set false. ## 1.x diff --git a/README.md b/README.md index 59cf0a7..cd869b8 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,13 @@ Note that the default and implicit value is always stored as a string, regardless of the type that you want to store it in. It will be parsed as though it was given on the command line. +## Boolean values + +Boolean options have a default implicit value of `"true"`, which can be +overridden. The effect is that writing `-o` by itself will set option `o` to +`true`. However, they can also be written with various strings using either +`=value` or the next argument. + # Linking This is a header only library.