From b6bd03077e855065d828911411c0dd431ff84424 Mon Sep 17 00:00:00 2001
From: erri120 <erri120@protonmail.com>
Date: Mon, 18 May 2020 13:56:51 +0200
Subject: [PATCH] Updated README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d6366a8..76a1a13 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,42 @@
-# Plugin Template
+# Utility Library
 
-Project template for developing [.NET Script Framework](https://www.nexusmods.com/skyrimspecialedition/mods/21294) Plugins.
+Utility Library for developing [.NET Script Framework](https://www.nexusmods.com/skyrimspecialedition/mods/21294) Plugins. This adds additional events, functions, extensions and more for you to work with so you can create plugins more efficient.
 
 ## Requirements
 
 * [Visual Studio 2019](https://visualstudio.microsoft.com/)
 * [.NET Script Framework](https://www.nexusmods.com/skyrimspecialedition/mods/21294)
+
+## Using the Library
+
+Aside from adding a reference to this in your project, you also need to make sure that the library loads before your plugin. Make sure your `Plugin.Initialize` function looks like this:
+
+```csharp
+protected override bool Initialize(bool loadedAny)
+{
+    var utilityLibrary = NetScriptFramework.PluginManager.GetPlugin("utility.library");
+    if (utilityLibrary == null) return false;
+    if (!utilityLibrary.IsInitialized) return false;
+    if (!loadedAny) return false;
+
+    // other stuff...
+}
+```
+
+This ensures that your plugin only loads after the library initialized and it will error out when the library is not loaded or initialized.
+
+### Functions
+
+The `UtilityLibrary` class has multiple convenience functions like `UtilityLibrary.IsInGame` or `UtilityLibrary.TryGetFormFromFile<T>` to reduce the amount of duplicate code you often write.
+
+### Events
+
+The `UtilityLibrary.Events` class contains new events that are (not yet) in the main framework.
+
+### Extensions
+
+Extensions are static functions that have a `this T` argument, this library features multiple extensions for `Actor` and `ItemEntry` objects.
+
+### AddressLibrary
+
+The Address Library `UtilityLibrary.AddressLibrary` is a collection of addresses that you can use without having to do any reverse engineering.