Add Option tests.

[command.git] / README

diff --git a/README b/README
index ec423e579015ece3e49a4a47ea6729dec4b112a9..0bb82e98645ba1296fe1003e8e34b92757757b27 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,18 @@
 Command, a C++ library for handling command line arguments
+
+Designing to be used like follows:
+
+Example:
+
+    void some_function(std::string str) {
+        std::cout << "Some function" << std::endl;
+    }
+
+    command::Command command(argc, argv, {
+        command::Option<std::string>("f", "File path", [](std::string value)->void { cout << "Sth: " << value << endl; }),
+        command::Argument<std::string>("File path", []()->void { cout << "Sth: " << value << endl; }),
+        command::Option<void>("help", "Help description", [](void)->void { cout << "Sth: " << value << endl; }),
+        command::Option<void>("verbose", "Verbose option description", &myClass->verbose),
+        command::Option<void>("verbose", "Verbose option description", some_function)
+    });
+