From fe9603d218d053795a73e98129b67890848c05c9 Mon Sep 17 00:00:00 2001
From: Emmanuel Garette <egarette@cadoles.com>
Date: Thu, 29 Nov 2018 22:47:12 +0100
Subject: [PATCH] add a simple example

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 561b2df..0d4c47d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,60 @@
 # tiramisu-parser
 
-Parser for command-line options and arguments using Tiramisu engine.
\ No newline at end of file
+Parser for command-line options and arguments using Tiramisu engine.
+
+# simple example
+
+
+```python
+#!/usr/bin/env python3
+
+from tiramisu_parser import TiramisuParser
+from tiramisu import StrOption, BoolOption, SymLinkOption, OptionDescription, \
+                     Config
+parser = TiramisuParser()
+booloption = BoolOption('verbosity',
+                        'increase output verbosity',
+                        default=False)
+config = Config(OptionDescription('root', 'root', [StrOption('var',
+                                                             'a string option',
+                                                             properties=('mandatory',
+                                                                         'positional')),
+                                                   booloption,
+                                                   SymLinkOption('v', booloption)]))
+parser.add_arguments(config)
+parser.parse_args()
+print('result:', config.value.dict())
+```
+
+```
+[gnunux@localhost tiramisu-parser]$ ./prog.py -h
+usage: prog.py [-h] [-v] var
+
+positional arguments:
+  var              a string option
+
+optional arguments:
+  -h, --help       show this help message and exit
+  -v, --verbosity  increase output verbosity
+```
+
+```
+[gnunux@localhost tiramisu-parser]$ ./prog.py -v
+usage: prog.py [-h] [-v] var
+prog.py: error: the following arguments are required: var
+```
+
+```
+[gnunux@localhost tiramisu-parser]$ ./prog.py test
+result: {'var': 'test', 'verbosity': False, 'v': False}
+```
+
+```
+[gnunux@localhost tiramisu-parser]$ ./prog.py -v test
+result: {'var': 'test', 'verbosity': True, 'v': True}
+```
+
+```
+[gnunux@localhost tiramisu-parser]$ ./prog.py --verbosity test
+result: {'var': 'test', 'verbosity': True, 'v': True}
+```