summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTyler Murphy <tylerm@tylerm.dev>2023-06-08 02:10:57 -0400
committerTyler Murphy <tylerm@tylerm.dev>2023-06-08 02:10:57 -0400
commit346bac811d32ddeb4fa129f548f617aa40a3dd61 (patch)
treeab8d5c813353067ec09dcabe0286c27cf6b4a618 /README.md
parentclippy my beloved (diff)
downloadleak_memory-346bac811d32ddeb4fa129f548f617aa40a3dd61.tar.gz
leak_memory-346bac811d32ddeb4fa129f548f617aa40a3dd61.tar.bz2
leak_memory-346bac811d32ddeb4fa129f548f617aa40a3dd61.zip
lleeaakk
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
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