diff --git a/README.md b/README.md index fd8a21e..00d92c5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,22 @@ ## ℹī¸ Features -* Reflection-assisted console. -* Minimal but functional UI (Unity IMGUI). -* Usable with existing code by default. -* Bind commands in editor or at runtime. -* Call static methods and properties. +* Reflection-based runtime console for Unity projects. +* No extras required - usable with existing code and wireable through inspector. +* Bind handlers for scene objects or project assets. +* Supports input and parsing of all primitive type arguments + common Unity structs (Vector2/3/4, Color...). +* Multiple input conventions supported (fn(x), fn x, variable=x) +* Minimalistic and functional UI (Unity IMGUI). +* 🤞 Reasonably lightweight. +
+ + +**⌛ In Progress** + +* [ ] Static methods and fields. +* [ ] Optional method parameters +* [ ] Automatic type casting for compatible types (float -> double...) +* [ ] Custom input parsers and type handlers.
@@ -20,27 +31,11 @@
-## 🚀 Usage +## 🚀 Use -**Bare Minimum** - 1. Create a `Console` asset in your project. -2. Add the `ConsoleGUI` script to your scene and drop a reference to the asset into it. - -### Instance - -todo +2. Add a `Console GUI` script to your scene and drop a reference to the asset into it. +3. Use `Console Handler` script to bind commands to scene objects. -#### Scene - -todo - - -### Static - - -
- -## \ No newline at end of file