diff --git a/README.md b/README.md index ec2c00b..9a64450 100644 --- 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 index 4f872f1..46c80f2 100644 --- 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).