WIP Add README

gilzoide · Nov 25, 2023 · 0830c1f · 0830c1f
1 parent 5d3dc8f
commit 0830c1f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Flex UI
+Flexible layout support for [Unity UI](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) using the [Yoga](https://yogalayout.dev/) layout engine.
+
+
+## Features
+- There is a single component you need: [FlexLayout](Runtime/FlexLayout.cs)
+- `FlexLayout` only layouts children that also have a `FlexLayout` component, so you can still use anchors and other Layout Elements.
+- Live updates in edit mode.
+
+
+## Caveats
+- Currently, the native library is build for macOS only
+
+
+## How to install
+Install directly using the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) with the following URL:
+```
+https://github.com/gilzoide/unity-flex-ui.git#1.0.0-preview1
+```
diff --git a/README.md.meta b/README.md.meta
diff --git a/package.json b/package.json
@@ -7,6 +7,5 @@
   "license": "Unlicense",
   "author": {
     "name": "Gil Barbosa Reis"
-  },
-  "unity": "2017.1"
-}
+  }
+}