Update README.md

Added more text and added a picture from the example project
Nyntex · May 27, 2024 · 16a74d5 · 16a74d5
1 parent d0c0145
commit 16a74d5
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,8 @@
 # Inventory-Library
- A library to create simple manageable inventories
+ This is a c++ static link library meant to be an easy and accessible game inventory that users can implement in their games. It handles the creation of items as well as how to add, remove, sort, filter and move around these items in the inventory.<br><br>
+ This library is composed of two header files, "Inventory.h" and "BaseItem.h". For a full explanation of how to include this library in a new C++ project as well as in an Unreal Engine module, [here is the wiki](https://github.com/Nyntex/Inventory-Library/wiki).
+The Wiki also contains all information about all members and methods of both classes for reference + an explanation what they do or what they are for, if you don't want to look through the code.
+<br><br>
+## Example project in Unreal Engine 5
+![Capture](https://github.com/Nyntex/Inventory-Library/assets/33361531/81e46a93-3813-401f-8a57-f614a0a0cb70)
+