From b8f4ca1169cb06c1d1927b73b1542a19214c93b6 Mon Sep 17 00:00:00 2001 From: Simon Brand Date: Tue, 30 Apr 2019 11:58:50 +0100 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 87418ef..6f3df43 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # optional + Single header implementation of `std::optional` with functional-style extensions and support for references. Clang + GCC: [![Linux Build Status](https://travis-ci.org/TartanLlama/optional.png?branch=master)](https://travis-ci.org/TartanLlama/optional) MSVC: [![Windows Build Status](https://ci.appveyor.com/api/projects/status/k5x00xa11y3s5wsg?svg=true)](https://ci.appveyor.com/project/TartanLlama/optional) +[![Documentation Status](https://readthedocs.org/projects/tl-docs/badge/?version=latest)](https://tl.tartanllama.xyz/en/latest/?badge=latest) `std::optional` is the preferred way to represent an object which may or may not have a value. Unfortunately, chaining together many computations which may or may not produce a value can be verbose, as empty-checking code will be mixed in with the actual programming logic. This implementation provides a number of utilities to make coding with `optional` cleaner. @@ -41,8 +43,6 @@ tl::optional get_cute_cat (const image& img) { } ``` -Full documentation available at [tl.tartanllama.xyz](https://tl.tartanllama.xyz) - The interface is the same as `std::optional`, but the following member functions are also defined. Explicit types are for clarity. - `map`: carries out some operation on the stored object if there is one.