From 67a725ff68c2af77be47dc7f859c053e95089844 Mon Sep 17 00:00:00 2001
From: apio <blobs.trading@gmail.com>
Date: Fri, 7 Oct 2022 16:35:32 +0200
Subject: [PATCH] Add README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..25c645c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# webcxx
+
+A simple web framework similar to Flask, but for C++.
+
+## Warning
+This project is in super-alpha state and should not be used in production. It's probably filled with bugs and security vulnerabilities. You have been warned.
+
+## How to use
+See [webcxx-example](https://git.cloudapio.eu/apio/webcxx-example).
+
+## How to add webcxx into your project (with CMake)
+Add this repo as a submodule.
+
+Append the following lines into your CMakeLists.txt:
+
+```
+include(webcxx/CMakeLists.txt)
+
+target_include_directories(<your-executable> PUBLIC ${webcxx_include})
+target_link_libraries(<your-executable> PUBLIC ${webcxx_libs})
+```
\ No newline at end of file