From abc598baf15d6f8a4de395a27ba34b1e769558e1 Mon Sep 17 00:00:00 2001 From: frosty Date: Wed, 18 Mar 2026 21:42:04 -0400 Subject: docs: update README.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a345f42..c9929b1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # 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. +## Disclaimer +I request that none of this code, in part or in full, be hosted on GitHub, SourceForge, or any other proprietary platform. This request is made out of respect for both me, the developer and for you, the user. + ## Usage Look at the files in examples for usage @@ -18,10 +21,13 @@ You can always override the destination: ```bash $ make install INSTALL_PREFIX=/some/prefix/ ``` - -## Roadmap -- Handle different types of POST requests +## Roadmap - Write documentation - Add more robust logging - Write more examples + +## Contribution +Generate a patch with ```git format-patch HEAD~1``` and email to [gabriel@bwaaa.monster](mailto:gabriel@bwaaa.monster), beginning the subject line with [PATCH beaker] + +*If you are sending a revised version of a previous patch, please use [PATCH beaker v2, v3, etc].* -- cgit v1.2.3