diff --git a/README.md b/README.md index 491928d..820ddaa 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# Oxide.Ext.MadMappers \ No newline at end of file +# Oxide.Ext.MadMappers + +๐Ÿ‡ฌ๐Ÿ‡ง English | [๐Ÿ‡ท๐Ÿ‡บ ะ ัƒััะบะธะน](README.ru.md) + +A library designed to extend and simplify development for Oxide-based Rust plugins. + +--- + +## ๐Ÿ“ฆ About + +This library is primarily intended for optimized plugin development within the Mad Mappers team, as well as ensuring proper functionality of custom maps created by the team. + +However, other developers can also use parts of this library to improve compatibility with Mad Mappers content. + +--- + +## ๐Ÿ“ฅ Installation + +Download the latest version of the DLL: + +https://github.com/Mad-Mappers/Oxide.Ext.MadMappers/raw/main/Oxide.Ext.MadMappers.dll + +### Steps: +1. Download the `.dll` file +2. Place it into your server's `RustDedicated_Data/Managed` folder +3. Restart the server + +--- + +## ๐Ÿ“š Documentation + +Detailed documentation will be available later.