docs: Add README.md files for flow and yoga-sys packages

grilme99 · Aug 26, 2023 · 5688343 · 5688343
1 parent d254021
commit 5688343
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/flow/README.md b/packages/flow/README.md
@@ -0,0 +1,5 @@
+# `flow`
+
+This package hosts an idiomatic Lua API wrapper for the low-level C API found in `yoga-sys`. All features available in
+the `yoga-sys` package should be available here, but if it is missing anything then please submit an issue or contribute
+a pull request!
diff --git a/packages/yoga-sys/README.md b/packages/yoga-sys/README.md
@@ -0,0 +1,4 @@
+# `yoga-sys`
+
+This package hosts a translation of Yoga (currently `v1.19.0`) and its public C-style API. It is not intended for direct
+consumption and you should instead be using `flow`, which brings a more idiomatic Lua API.