aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..998fdbf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Beaker
+Beaker is a lightweight web framework written in C, designed for building simple and efficient web applications. It currently provides handling HTTP requests, routing, serving static files, rendering HTML templates and managing cookies.
+
+## Usage
+Look at the files in examples for usage
+
+## Installation
+```bash
+ git clone https://github.com/gabrielf35/beaker.git
+ cd beaker
+ sudo make install
+```
+
+## Roadmap
+
+- Handle different types of POST requests
+- Write documentation
+- Add more robust logging
+- Write more examples \ No newline at end of file