Saving designed syntax

[command.git] / README

diff --git a/README b/README
index ec423e579015ece3e49a4a47ea6729dec4b112a9..add86148f874625eacb9a9b69dbe4517edf49c95 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,12 @@
 Command, a C++ library for handling command line arguments
+
+Designing to be used like follows:
+
+Example:
+    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)
+    });
+