update README

This commit is contained in:
2019-05-05 08:02:03 +07:00
parent 21693a8e66
commit 65963bc670

View File

@@ -25,14 +25,15 @@
## Installation
[flat.hpp][flat] is a header only library. All you need to do is copy the header files (`flat_set.hpp` and `flat_map.hpp`) into your project and include them:
[flat.hpp][flat] is a header only library. All you need to do is copy the header files (`flat_set.hpp` and `flat_map.hpp`) into your project and include them.
```cpp
#include "flat_set.hpp"
#include "flat_map.hpp"
```
## API
- [Flat Set](#flat-set)
- [Flat Map](#flat-map)
- [Flat Multiset](#flat-multiset)
- [Flat Multimap](#flat-multimap)
## flat_set
## Flat Set
```cpp
template < typename Key
@@ -223,7 +224,7 @@ bool operator>=(
const flat_set<K, C, A>& r);
```
## flat_map
## Flat Map
```cpp
template < typename Key
@@ -431,4 +432,12 @@ bool operator>=(
const flat_map<K, V, C, A>& r);
```
## Flat Multiset
> coming soon!
## Flat Multimap
> coming soon!
## [License (MIT)](./LICENSE.md)