summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/lua-tinyyaml/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/lua-tinyyaml/README.md')
-rw-r--r--macros/luatex/generic/lua-tinyyaml/README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/macros/luatex/generic/lua-tinyyaml/README.md b/macros/luatex/generic/lua-tinyyaml/README.md
index a3eee15a9b..239ebea6c3 100644
--- a/macros/luatex/generic/lua-tinyyaml/README.md
+++ b/macros/luatex/generic/lua-tinyyaml/README.md
@@ -1,15 +1,24 @@
# lua-tinyyaml
-<https://github.com/api7/lua-tinyyaml>
+- Homepage: https://github.com/zepinglee/citeproc-lua
+- Author: Zeping Lee
+- Email: zepinglee AT gmail DOT com
+- License: MIT
-A tiny YAML (subset) parser for pure Lua.
+The `lua-tinyyam` package is a lightweight YAML parser
+written in pure Lua. It supports a subset of the YAML 1.2
+specifications. This package is a dependency for several other LuaTeX
+packages, including `markdown` and
+`citeproc-lua`.
## Usage
+To parse a YAML string into a Lua table, use the `parse` function:
+
```lua
-require('tinyyaml').parse(str)
+contents = require("tinyyaml").parse(str)
```
## License
-MIT License
+`lua-tinyyaml` is distributed under the MIT License.