Added README.md file

This commit is contained in:
Andrzej Krzemienski
2014-04-28 16:01:55 +02:00
parent c7cf80e5df
commit 655a9e3035

15
README.md Normal file
View File

@ -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.