From d8f20caa120537363f8ecb367baf5fde150a9d06 Mon Sep 17 00:00:00 2001
From: Anna <git@anna.lgbt>
Date: Tue, 11 Jan 2022 05:32:26 -0500
Subject: [PATCH] chore: add readme

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100755 README.md

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..c0bd5b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Siggingway
+
+Signature attribute for making working with signatures in Dalamud plugins super
+braindead.
+
+## Usage
+
+```c#
+public class Plugin : IDalamudPlugin {
+    [Signature("DE AD ?? EF", DetourName = nameof(MyDetour)]
+    private Hook<MyDelegate>? MyHook { get; init; }
+    
+    [Signature("CA ?? BA BE")]
+    private SomeGameFunctionDelegate? _someGameFunction;
+    private delegate void SomeGameFunctionDelegate();
+
+    public Plugin(SigScanner scanner) {
+        Siggingway.Siggingway.Initialise(scanner, this);
+    
+        // you still have to enable the hook
+        // be sure to check if it's null    
+        this.MyHook?.Enable();
+    }
+    
+    public void Dispose() {
+        this.MyHook?.Dispose();
+    }
+    
+    private void MyDetour() {
+        // this is called by the hook!
+
+        this._someGameFunction?.Invoke();
+    }
+}
+```