mirror of
https://github.com/maxartz15/UnitySerializedReferenceUI.git
synced 2024-11-24 08:35:36 +01:00
update readme to include installation and an example
This commit is contained in:
parent
ffff19acd5
commit
d315c7848f
25
README.md
25
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.
|
@ -23,7 +23,7 @@
|
||||
],
|
||||
"author":
|
||||
{
|
||||
"name": "TextusGames",
|
||||
"name": "Textus Games",
|
||||
"url": "https://github.com/TextusGames"
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user