initial commit

README.md

@@ -0,0 +1,41 @@
+# enum.hpp
+
+[![travis][badge.travis]][travis]
+[![appveyor][badge.appveyor]][appveyor]
+[![codecov][badge.codecov]][codecov]
+[![language][badge.language]][language]
+[![license][badge.license]][license]
+[![paypal][badge.paypal]][paypal]
+
+[badge.travis]: https://img.shields.io/travis/BlackMATov/enum.hpp/master.svg?logo=travis
+[badge.appveyor]: https://img.shields.io/appveyor/ci/BlackMATov/enum-hpp/master.svg?logo=appveyor
+[badge.codecov]: https://img.shields.io/codecov/c/github/BlackMATov/enum.hpp/master.svg?logo=codecov
+[badge.language]: https://img.shields.io/badge/language-C%2B%2B17-yellow.svg
+[badge.license]: https://img.shields.io/badge/license-MIT-blue.svg
+[badge.paypal]: https://img.shields.io/badge/donate-PayPal-orange.svg?logo=paypal&colorA=00457C
+
+[travis]: https://travis-ci.org/BlackMATov/enum.hpp
+[appveyor]: https://ci.appveyor.com/project/BlackMATov/enum-hpp
+[codecov]: https://codecov.io/gh/BlackMATov/enum.hpp
+[language]: https://en.wikipedia.org/wiki/C%2B%2B17
+[license]: https://en.wikipedia.org/wiki/MIT_License
+[paypal]: https://www.paypal.me/matov
+
+[enum]: https://github.com/BlackMATov/enum.hpp
+
+## Installation
+
+[enum.hpp][enum] is a header-only library. All you need to do is copy the headers files from `headers` directory into your project and include them:
+
+```cpp
+#include "enum.hpp/enum.hpp"
+```
+
+Also, you can add the root repository directory to your [cmake](https://cmake.org) project:
+
+```cmake
+add_subdirectory(external/enum.hpp)
+target_link_libraries(your_project_target enum.hpp)
+```
+
+## [License (MIT)](./LICENSE.md)