summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-06-20 21:44:26 +0200
committerGitHub <[email protected]>2020-06-20 21:44:26 +0200
commitf4ea94c315716b51227132927643d22182b6e94a (patch)
treebd1db9e87eadcabd259536fc2e8b6fd83b1c4581
parenta82bec44a0c0ac564c19090c4117742ecf942775 (diff)
downloadSTC-modified-f4ea94c315716b51227132927643d22182b6e94a.tar.gz
STC-modified-f4ea94c315716b51227132927643d22182b6e94a.zip
Update README.md
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index ffa9a569..9e2315d7 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,16 @@ STC - C99 Standard Container Library
Introduction
------------
-An elegant, modern, generic, customizable, typesafe, and very efficient standard container library for C99. This is a small headers only library with the most used container components: **cstring**, **cvector**, **chash** (map and set), **carray** (multi-dim. dynamic array), and **clist** (circular singly linked list, suited to be used as queue).
+An elegant, modern, generic, customizable, typesafe, consistent, user-friendly, and very efficient standard container library for C99. This is a small headers only library with the most used container components:
+- **CString** - Compact and powerful string class
+- **CVector** - Dynamic generic vector class.
+- **CHash** - Unorderd map and set.
+- **CArray** - Multi-dimensional dynamic array
+- **CList** - A circular singly linked list, suited to be used as queue (supports pushBack, pushFront, and popFront).
The usage is quite similar to c++ standard containers, so it should be easy for those who are familiar with that.
-All containers mentioned above, except for CString are generic (similar to templates in C++). The typical usage is:
+All containers mentioned above, except for CString are generic (similar to templates in C++). A simple example:
```
#include <stc/vector.h>
declare_CVector(i, int);