Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
  • Loading branch information
fzipi committed Nov 9, 2023
1 parent 7e5b812 commit 1c4c699
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
THIS MODULE IS NOT PRODUCTION READY
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

👉 YOU CANNOT CREATE ISSUES HERE, BUT YOU CAN CREATE PULL REQUESTS FIXING PROBLEMS 👈

🙏 DO NOT CREATE PULL REQUESTS TO COMPLAIN ABOUT THINGS NOT WORKING. THIS IS EXPERIMENTAL AND NO WORK IS BEING DONE HERE.

👉YOU ARE WELCOME TO WORK ON IT AND SEND PULL REQUESTS! 👈

[![Compile module](https://github.com/corazawaf/coraza-nginx/actions/workflows/build.yml/badge.svg)](https://github.com/corazawaf/coraza-nginx/actions/workflows/build.yml)

# Coraza NGINX Connector
Expand All @@ -6,6 +16,8 @@ The coraza-nginx connector is the connection point between nginx and libcoraza.

# Compilation

If you have any doubts, please read the [GitHub build Action](https://github.com/corazawaf/coraza-nginx/blob/master/.github/workflows/build.yml) for additional information.

Before compile this software make sure that you have libcoraza installed.
You can download it from the [libcoraza git repository](https://github.com/corazawaf/libcoraza). For information pertaining to the compilation and installation of libcoraza please consult the documentation provided along with it.

Expand Down

0 comments on commit 1c4c699

Please sign in to comment.