update docs with read_string function

teamtomo · Aug 14, 2024 · 18cdc4c · 18cdc4c
1 parent d6ba9cc
commit 18cdc4c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,15 @@ import mdocfile
 df = mdocfile.read('my_mdoc_file.mdoc')
 ```
 
+`mdocfile.read_string()` will read mdoc file data stored in a string
+
+```python
+
+import mdocfile
+
+df = mdocfile.read_string('...mdoc string data...')
+```
+
 For writing valid mdoc files, please see 
 [writing mdoc files](https://teamtomo.org/mdocfile/writing/).
 

diff --git a/docs/index.md b/docs/index.md
@@ -29,6 +29,15 @@ import mdocfile
 df = mdocfile.read('my_mdoc_file.mdoc')
 ```
 
+`mdocfile.read_string()` will read mdoc file data stored in a string
+
+```python
+
+import mdocfile
+
+df = mdocfile.read_string('...mdoc string data...')
+```
+
 ---
 
 For writing valid mdoc files, please see [writing mdoc files](./writing.md).