summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..13f442a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+* Shady Flag Library
+
+This is a library for parsing command line flags.
+Just include the .h file and you're good to go.
+Example:
+```int hello = flag_int("--testing", 420, "<something> Hello World");```
+This will put on the variable hello the value following the --testing command
+line flag, or the default value 420 if the flag is not present.