From 65963bc6700918ed732ab75aef5c318127854f26 Mon Sep 17 00:00:00 2001 From: BlackMATov Date: Sun, 5 May 2019 08:02:03 +0700 Subject: [PATCH] update README --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e3da0c9..1c658a9 100644 --- a/README.md +++ b/README.md @@ -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& r); ``` -## flat_map +## Flat Map ```cpp template < typename Key @@ -431,4 +432,12 @@ bool operator>=( const flat_map& r); ``` +## Flat Multiset + +> coming soon! + +## Flat Multimap + +> coming soon! + ## [License (MIT)](./LICENSE.md)