mirror of
https://github.com/arcan1s/result.git
synced 2025-04-24 23:47:18 +00:00
update readme
This commit is contained in:
parent
de94719320
commit
475cb92969
10
README.md
10
README.md
@ -6,13 +6,21 @@ Simple header-only variant-driven C++17 `Result<T,E>` implementation.
|
|||||||
|
|
||||||
* c++17 or c++1z with support of variant
|
* c++17 or c++1z with support of variant
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
* Small, header-only.
|
||||||
|
* Pure C++.
|
||||||
|
* Human and machine readable (with custom return errors support) error
|
||||||
|
representation.
|
||||||
|
* Compile-time check of dereference.
|
||||||
|
|
||||||
## Usage example
|
## Usage example
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
#include <cassert>
|
#include <cassert>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
#include "result.h"
|
#include "result.hpp"
|
||||||
|
|
||||||
using namespace std::string_literals;
|
using namespace std::string_literals;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user