Change some descriptions

Author: Hasenpfote

README.md

@@ -8,6 +8,66 @@ malloc_tracer
 ## About
 This is a debugging tool for tracing malloc that occurs inside a function or class.  
 
+```python
+import numpy as np
+from malloc_tracer.tracer import *
+
+
+def func(x, y, z):
+    dataset1 = np.empty((100, ), dtype=np.float64)
+    print('x', x)
+    dataset1 = np.empty((1000, ), dtype=np.float64)
+
+    l = [i for i in range(100000)]
+
+    if x == 0:
+        dataset4a = np.empty((100000, ), dtype=np.float64)
+        return 0
+    elif x == 1:
+        dataset4b = np.empty((100000, ), dtype=np.float64)
+        return 1
+
+    dataset3 = np.empty((3000, ), dtype=np.float64)
+    return 2
+
+
+tracer = Tracer(func)
+```
+
+This is equivalent to the following code.
+
+```python
+import numpy as np
+from tracemalloc import start, take_snapshot, stop
+
+
+SNAPSHOT = None
+
+
+def func(x, y, z):
+    try:
+        start()
+        dataset1 = np.empty((100,), dtype=np.float64)
+        print('x', x)
+        dataset1 = np.empty((1000,), dtype=np.float64)
+
+        l = [i for i in range(100000)]
+
+        if (x == 0):
+            dataset4a = np.empty((100000,), dtype=np.float64)
+            return 0
+        elif (x == 1):
+            dataset4b = np.empty((100000,), dtype=np.float64)
+            return 1
+
+        dataset3 = np.empty((3000,), dtype=np.float64)
+        return 2
+    finally:
+        global SNAPSHOT
+        SNAPSHOT = take_snapshot()
+        stop()
+```
+
 ## Feature
 
 ## Compatibility

README.rst

@@ -11,6 +11,66 @@ About
 This is a debugging tool for tracing malloc that occurs inside a
 function or class.
 
+.. code:: python
+
+   import numpy as np
+   from malloc_tracer.tracer import *
+
+
+   def func(x, y, z):
+       dataset1 = np.empty((100, ), dtype=np.float64)
+       print('x', x)
+       dataset1 = np.empty((1000, ), dtype=np.float64)
+
+       l = [i for i in range(100000)]
+
+       if x == 0:
+           dataset4a = np.empty((100000, ), dtype=np.float64)
+           return 0
+       elif x == 1:
+           dataset4b = np.empty((100000, ), dtype=np.float64)
+           return 1
+
+       dataset3 = np.empty((3000, ), dtype=np.float64)
+       return 2
+
+
+   tracer = Tracer(func)
+
+This is equivalent to the following code.
+
+.. code:: python
+
+   import numpy as np
+   from tracemalloc import start, take_snapshot, stop
+
+
+   SNAPSHOT = None
+
+
+   def func(x, y, z):
+       try:
+           start()
+           dataset1 = np.empty((100,), dtype=np.float64)
+           print('x', x)
+           dataset1 = np.empty((1000,), dtype=np.float64)
+
+           l = [i for i in range(100000)]
+
+           if (x == 0):
+               dataset4a = np.empty((100000,), dtype=np.float64)
+               return 0
+           elif (x == 1):
+               dataset4b = np.empty((100000,), dtype=np.float64)
+               return 1
+
+           dataset3 = np.empty((3000,), dtype=np.float64)
+           return 2
+       finally:
+           global SNAPSHOT
+           SNAPSHOT = take_snapshot()
+           stop()
+
 Feature
 -------