From cda29dd3173e4963dd96a4a9558d90f6b9bdae2c Mon Sep 17 00:00:00 2001
From: ari melody <ari@arimelody.me>
Date: Tue, 13 Feb 2024 03:19:25 +0000
Subject: [PATCH] update readme

---
 README.md | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index fc17ff6..f235539 100644
--- a/README.md
+++ b/README.md
@@ -4,20 +4,20 @@ it allocates memory
 
 ## how to use
 
-- run the executable
-- enter how much memory you want to allocate
-        - i.e. "1g" = 1 GiB = 1073741824 bytes
-        - the limit is how much memory you have...or more. your funeral.
-- confirm (y)
-- wait for the program to allocate the memory
-- your memory is allocated
-- press ENTER or CTRL+C to free the memory and exit the program
-- ???
-- profit
+```
+usage: allocatememory -b <bytes> [-o <output file>] [-s]
+
+OPTIONS
+  -h    displays help
+  -b    number of bytes to allocate (e.g. 1024, 1g, 64K)
+  -o    file to output to
+  -s    run silently (requires -b and -o)
+  -w    disable warnings ("i know what i'm doing!")
+```
 
 ## how to compile
 
-- get a c compiler (i use gcc)
+- get a c compiler (i use gcc or clang)
 - `gcc -o ./allocatememory -O2 ./main.c`
 - ???
 - profit