summaryrefslogtreecommitdiffhomepage
path: root/Readme.mdown
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.mdown')
-rw-r--r--Readme.mdown16
1 files changed, 15 insertions, 1 deletions
diff --git a/Readme.mdown b/Readme.mdown
index f5019b3..fbde033 100644
--- a/Readme.mdown
+++ b/Readme.mdown
@@ -1,3 +1,17 @@
# Arraylist
-Generic arraylist implementation in C. WIP.
+Generic arraylist single header implementation in C.
+
+## How to use
+Define it in your main file like so:
+```
+#define ARRAYLIST_IMPLEMENTATION
+#include "arraylist.h"
+#undef ARRAYLIST_IMPLEMENTATION
+```
+and for any other files you would also like to use it in simply do
+```
+#include "arraylist.h"
+```
+---
+Define `ARRAYLIST_DEFAULT_SIZE` to a value of your choice to change the default initialized size(number of elements) of an arraylist.