From e5938a0cc6988e0aa29dcb44d09556bfbbf4eafa Mon Sep 17 00:00:00 2001
From: clerie <git@clerie.de>
Date: Thu, 6 Jan 2022 16:13:05 +0100
Subject: [PATCH] Give some quickstart documentation

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 651fcab..cf16521 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # Mitel OMMClient2
 
 Another attempt for a client library to the Mitel OM Application XML Interface.
+
+## Quicksart
+
+Just some examples to give you an idea what this does.
+
+```
+import mitel_ommclient2
+
+# Connect to your OMM
+c = mitel_ommclient2.OMMClient2("omm.local", "admin", "admin")
+
+# Use built in methods for common actions
+c.ping()
+
+# Create custom messages
+r = c.session.request(mitel_ommclient2.messages.Ping(timeStamp=2342))
+
+# Craft your own request, if it is not implemented yet
+r = c.session.request(mitel_ommclient2.messages.DictRequest("Ping", {"timeStamp": 2342}))
+```
+
+Consult class documentation for more in depth examples and options.