From 4a3dabd6386875fe7d3ebe99cde506ad3a016521 Mon Sep 17 00:00:00 2001
From: "Vanya A. Sergeev" <v@sergeev.io>
Date: Sun, 1 Mar 2020 17:05:46 -0600
Subject: [PATCH] add use_tuple unpacking option usage to readme

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

diff --git a/README.md b/README.md
index 20360ed..869f76e 100644
--- a/README.md
+++ b/README.md
@@ -225,6 +225,18 @@ OrderedDict([('compact', True), ('schema', 0)])
 >>> 
 ```
 
+## Tuples
+
+The unpacking functions provide a `use_tuple` option to unpack MessagePack arrays into tuples, rather than lists.
+
+``` python
+>>> umsgpack.unpackb(b'\x93\xa1a\xc3\x92\x01\x92\x02\x03')
+['a', True, [1, [2, 3]]]
+>>> umsgpack.unpackb(b'\x93\xa1a\xc3\x92\x01\x92\x02\x03', use_tuple=True)
+('a', True, (1, (2, 3)))
+>>> 
+```
+
 ### Invalid UTF-8 Strings
 
 The unpacking functions provide an `allow_invalid_utf8` option to unpack MessagePack strings with invalid UTF-8 into the `umsgpack.InvalidString` type, instead of throwing an exception. The `umsgpack.InvalidString` type is a subclass of `bytes`, and can be used like any other `bytes` object.