From 40f8624e12ce89d962007a9028a46343b09fab4e Mon Sep 17 00:00:00 2001
From: absolutelyNoWarranty <absolutelyNoWarranty@users.noreply.github.com>
Date: Mon, 14 Oct 2019 19:47:49 +0800
Subject: [PATCH] docs: edit readme to show summary() usage

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

diff --git a/README.md b/README.md
index 34b0aed..e25a5c9 100644
--- a/README.md
+++ b/README.md
@@ -58,6 +58,33 @@ Let's create a Pipe to preprocess a Datum with English utterance.
 )
 ```
 
+examine its summary
+
+```
+>>> p.summary()
+________________________________________________________________________________
+Type  Operator
+================================================================================
+str
+ v
+ |    IntTokenWithSpace()
+ |    FloatTokenWithSpace()
+ |    MergeWhiteSpaceCharacters()
+ |    StripWhiteSpaceCharacters()
+ |    EngTokenizer()
+ v
+list
+ v
+ |    AddSosEos(end_token='<eos>', start_token='<sos>')
+ |
+ @--> checkpoint: 'result_of_add_sos_eos'
+ |
+ |    Pad(maxlen=5, pad_token='<pad>')
+ |    Token2Index(token2index={'<sos>': 0, '<eos>': 1, ...}, unk_token='<unk>')
+ v
+================================================================================
+```
+
 ## transform
 
 ```python