Add README with HermesOnDisk usage documentation

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..262fa1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# HermesOnDisk
+
+It's a dump, stupid game archive system, but FAST.
+
+## HOW TO USE
+
+```csharp
+HermesOnDisk.Root = new DirectoryInfo(Application.persistentDataPath);
+
+// Read
+bool doorOpen = HermesOnDisk.Boolean[2];
+float hp = HermesOnDisk.Float[0];
+string name = HermesOnDisk.String[0];
+
+// Write
+HermesOnDisk.Boolean[0] = true;
+HermesOnDisk.Float[0] = 100f;
+HermesOnDisk.String[0] = "Peter";
+
+// Store & Cleanup
+HermesOnDisk.Store();
+HermesOnDisk.GC();
+```