Upload README.md

README.md

@@ -1,3 +1,30 @@
----
-license: mit
----
+# Table of Contents
+
+* [MemoryReadingAtomicFlow](#MemoryReadingAtomicFlow)
+  * [MemoryReadingAtomicFlow](#MemoryReadingAtomicFlow.MemoryReadingAtomicFlow)
+* [\_\_init\_\_](#__init__)
+
+<a id="MemoryReadingAtomicFlow"></a>
+
+# MemoryReadingAtomicFlow
+
+<a id="MemoryReadingAtomicFlow.MemoryReadingAtomicFlow"></a>
+
+## MemoryReadingAtomicFlow Objects
+
+```python
+class MemoryReadingAtomicFlow(AtomicFlow)
+```
+
+A flow to read memory from given files.
+
+Any composite flow that uses this flow should have
+memory_files: Dict[str, str] which maps memory name to its memory file location in the flow_state
+
+*Input Interface*: - `memory_files` : name of the Dict which maps the memory name to its file location e.g.
+{"plan": "examples/JARVIS/plan.txt"}
+
+<a id="__init__"></a>
+
+# \_\_init\_\_
+