Adding README

aardvarkk · aardvarkk · commit 27658534e9ba · 2016-10-18T14:42:47.000-04:00
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# cppure
+## A basic profanity filter written in C++
+
+### Include the header file and compile `cppure.cpp`
+
+```
+#include "cppure.h"
+```
+
+### Load a wordlist
+
+```
+cppure::load_wordlist("wordlist.txt");
+```
+
+### Cleanse a string
+
+```
+auto cleansed = cppure::cleanse("badword");
+```
