Update README.md

README.md

@@ -1,3 +1,33 @@
 ---
-license: mit
+license: apache-2.0
+library_name: unity-sentis
+pipeline_tag: object-detection
 ---
+
+# *** WARNING: Not to be made live yet. Has memory leak in NMS Layer *** #
+
+# YOLOv8n validated for Unity Sentis
+
+This is a real-time multi-object recognition model confirmed to run in Unity 2023.
+
+## How to Use
+First get the package `com.unity.sentis` from the package manager.
+You will also need the Unity UI package.
+
+* Create a new scene in Unity 2023.
+* Add the c# script to the Main Camera.
+* Create a Raw Image in the scene and link it as the `displayImage`
+* Put the yolov8n.sentis file in the Assets/StreamingAssets folder
+* Drag the classes.txt on to the labelAssets field
+* Put a video file in the Assets/StreamingAssets folder and set the name of videoName to the filename in the script
+* Set the fields for the bounding box texture sprite and the font
+
+
+## Preview
+If working correctly you should see something like this:
+
+![preview](preview.png)
+
+
+## Unity Sentis
+Unity Sentis is the inference engine that runs in Unity 3D. More information can be found at [here](https://unity.com/products/sentis)