Added Makefile, Readme and MIT license

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd731ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# CodepointIterator
+
+... is a `std::iterator` derived class implementing the `std::bidirectional_iterator_tag` which iterates through unicode codepoints in a UTF8-encoded string.
+
+## Current features:
+
+- Bidirectional iteration through unicode codepoints
+- The class itself does not rely on any external libraries
+- Dereferencing an instance of the iterator yields the codepoint as `char32_t`
+- Unit Tests based on GoogleTest
+
+## Requirements:
+
+- [GoogleTest](http://code.google.com/p/googletest/) for tests