Update docs and changelog

Author: gabriel376

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Added
 
+- Added `:required` for `:flags`
+
 ## Fixed
 
 ## Changed
@@ -87,4 +89,4 @@ approaching the envisioned scope for this library.
 
 - subcommand handling 
 - rudimentary flag handling
-- help text generation
+- help text generation

README.md

@@ -241,7 +241,7 @@ If you are explicit about which flags you accept, then you may prefer not to let
 you can set `:strict? true`. In this mode only explicitly configured flags are
 accepted, others throw an error.
 
-A final possibility is to set `:middleware` for a flag, this is a function or
+Another possibility is to set `:middleware` for a flag, this is a function or
 list of functions that get wrapped around the final command.
 
 ```clj
@@ -257,6 +257,18 @@ list of functions that get wrapped around the final command.
                               (cmd opts))))]}]}]})
 ```
 
+Finally, it's possible to set `:required`, to indicate for users that a flag
+must always be passed:
+
+```clj
+(cli/dispatch
+ {:command #'cli-test
+  :flags ["-v, --verbose" "Increases verbosity"
+          "--input FILE" "Specify the input file"
+          "--env=<dev|prod|staging>" {:doc "Select an environment"
+                                      :required true}] })
+```
+
 ### Commands
 
 `lambdaisland/cli` is specifically meant for CLI tools with multiple subcommands

src/lambdaisland/cli.clj

@@ -413,6 +413,7 @@
     take an argument.
   - `:middleware` Function or sequence of functions that will wrap the command
     function if this flag is present.
+  - `:required` Boolean value to indicate if the flag is required.
 
   This docstring is just a summary, see the `com.lambdaisland/cli` README for
   details.