From d315c7848f76c37910cb9a6bf00e7aac888a9027 Mon Sep 17 00:00:00 2001
From: Phill <philldamaskin@gmail.com>
Date: Wed, 26 May 2021 14:53:19 -0400
Subject: [PATCH] update readme to include installation and an example

---
 README.md    | 25 +++++++++++++++++++++++++
 package.json |  2 +-
 2 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3fea68e..c356ecc 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,28 @@ Future plans:
 Possibly
 - copy / paste.
 - menu with searchbar.
+
+## Installation
+Use the + inside the Package Manager window and add this URL:
+```json
+"com.textus-games.serialized-reference-ui": "https://github.com/popcron/UnitySerializedReferenceUI.git"
+```
+Or add id to your `packages.json` file manually (located inside the project's Packages folder).
+
+## Example
+![Woah UI woah woah!!!](https://cdn.discordapp.com/attachments/784916261871550494/847185548632260628/unknown.png)
+```cs
+[Serializable]
+public class Slot
+{
+    [SerializeReference, SerializeReferenceButton]
+    public Item item;
+}
+
+[Serializable]
+public class Item {}
+public class Metal : Item {}
+public class Wood : Item {}
+```
+
+For more examples, this package contains two Samples that can be imported into your project.
\ No newline at end of file
diff --git a/package.json b/package.json
index 432e085..ddc9719 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
     ],
     "author": 
     {
-        "name": "TextusGames",
+        "name": "Textus Games",
         "url": "https://github.com/TextusGames"
     }
 }
\ No newline at end of file