made README worth a dime

README.md

@@ -1 +1,45 @@
 # Jëger
+A regex engine.
+
+### Syntax
+The aim was to follow Vim's regex syntax. Esoteric special characters such as "\zs" are not implemented, however the just is supported.
+| :----: | :---------------------: |
+| Symbol | Meaning (TODO: fill in) |
+| :----: | :---------------------: |
+| .      | |
+| =      | |
+| +      | |
+| *      | |
+| ?      | |
+| \\<    | |
+| \\>    | |
+| ^      | |
+| \t     | |
+| \n     | |
+| \b     | |
+| \i     | |
+| \I     | |
+| \k     | |
+| \K     | |
+| \f     | |
+| \F     | |
+| \p     | |
+| \P     | |
+| \s     | |
+| \d     | |
+| \D     | |
+| \x     | |
+| \X     | |
+| \o     | |
+| \O     | |
+| \w     | |
+| \W     | |
+| \h     | |
+| \a     | |
+| \l     | |
+| \L     | |
+| \u     | |
+| \U     | |
+| [\<range\>]   | |
+| [\^\<range\>] | |
+| :----: | :---------------------: |