Adding a little info to the docs

Henry Fredrick Schreiner · Henry Schreiner
1 parent 077ba404
Showing 2 changed files with 3 additions and 0 deletions
README.md
include/CLI/App.hpp
@@ -132,6 +132,8 @@ app.add_set(option_name,
  
 app.add_set_ignore_case(... // String only
  
+app.add_help_flag(name, optional_discription);
+
 App* subcom = app.add_subcommand(name, discription);
 ```
  
@@ -331,6 +331,7 @@ class App {
         return opt;
     }
  
+    /// Add a help flag, currently throws an error if already set
     Option *add_help_flag(std::string name, std::string description = "") {
         if(help_ptr_)
             throw IncorrectConstruction("Help flag already initialized");