X-Git-Url: https://git.auder.net/?p=cgds.git;a=blobdiff_plain;f=README.md;fp=README.md;h=8728d3e33f2093a82812efad74c7376006bb1917;hp=0000000000000000000000000000000000000000;hb=7ea34c03470cdde0d8b6cf2378cdb7d46175185d;hpb=3d3b840b1ba1f523c0098afed3c8ecc61caf9ced

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8728d3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# cgds: C Generic Data Structures library</h1>
+
+Various data structures, from stack to tree, which can contain any data type.</p>
+
+## Example
+
+	Vector v = vector_new(int);
+	vector_push(v, 32);
+	vector_push(v, 42);
+	int a; vector_get(v, 1, a); //a now contains 42
+	vector_set(v, 0, 0); //v[0] now contains 0
+	vector_destroy(v);</code></pre>
+
+More examples in the unit tests under test/ folder.</p>