From 297529926cefcc89028d5e2257e53953e0c0cc98 Mon Sep 17 00:00:00 2001
From: ZedDevStuff <98429642+ZedDevStuff@users.noreply.github.com>
Date: Thu, 29 Sep 2022 13:00:59 +0000
Subject: [PATCH 1/2] Create README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9feb328
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# UltraAchievement-Core
+BepInEx plugin made to add support for simple custom achievements to (theorically) any BepInEx5 compatible game
+This mod does nothing on its own.
+
+# Installing
+Download the latest realeased .DLL from the releases page and put it in your BepInEx plugin folder or if you use a modloader (ie UMM for ultrakill), put it in its mod folder
+
+# Adding support for your mod
+Adding support for this mod is extremely simple, just add the logic for detecting when the achievement should be given to the player then call 
+```cs
+Core.ShowAchievement(icon,string name,string description)
+```
+`icon` can either be a path to the icon or a `Sprite`. The mod will take care of the rest and keep track of previously acquired achievements so not duplicates shall occur.
+Currently, the mod only allows you to show an achievement but in the future there may be more features.
+Also feel free to fork if you want to add anything. 

From 00b40862e374baadce07e8b9efb3685c0c46f9a3 Mon Sep 17 00:00:00 2001
From: ZedDevStuff <98429642+ZedDevStuff@users.noreply.github.com>
Date: Thu, 29 Sep 2022 13:02:42 +0000
Subject: [PATCH 2/2] Update README.md

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

diff --git a/README.md b/README.md
index 9feb328..8b9b38a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # UltraAchievement-Core
-BepInEx plugin made to add support for simple custom achievements to (theorically) any BepInEx5 compatible game
-This mod does nothing on its own.
+BepInEx plugin made to add support for simple custom achievements to (theorically) any BepInEx 5 compatible game
+This mod does nothing on its own. At first, I made it for Ultrakill but decided to make it without any dependency to anything so anyone can use it anywhere.
 
 # Installing
 Download the latest realeased .DLL from the releases page and put it in your BepInEx plugin folder or if you use a modloader (ie UMM for ultrakill), put it in its mod folder