1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b620d31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+# Leak Memory
+
+leaks memory uwu
+
+## Examples
+
+Leak 1337 bytes of memory
+
+```rs
+use leak_memory::{leak, LeakMethod};
+
+fn main() {
+    leak(1337, LeakMethod::Lazy);
+}
+```
+
+Leak 69 kibibytes
+
+```rs
+use leak_memory::{leak, LeakMethod, LeakAmount};
+
+fn main() {
+    leak("69kib".parse::<LeakAmount>().unwrap(), LeakMethod::Rust);
+}
+```
+
+
+## Compilation
+
+dont