From 655a9e3035e8031829ce328b8e8424ed1bbf5c15 Mon Sep 17 00:00:00 2001
From: Andrzej Krzemienski <akrzemi1@gmail.com>
Date: Mon, 28 Apr 2014 16:01:55 +0200
Subject: [PATCH] Added README.md file

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4f73388
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+optional
+========
+
+A library for representing optional (nullable) objects in C++.
+
+```cpp
+optional<int> readInt(); // this function may return either an int or a not-an-int
+
+if (optional<int> oi = readInt()) // did I get a real int
+  cout << "my int is: " << *oi;   // use my int
+else
+  cout << "I have no int";
+```
+
+For more information refer to the documentation provided with this library.