From 72a7024512afe029c968920b99066a446fe9418a Mon Sep 17 00:00:00 2001
From: potatso <bangzhiliang@gmail.com>
Date: Fri, 7 Jul 2023 14:59:34 +0800
Subject: [PATCH] update readme

---
 README.md | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 05b6c88..c8cf1dd 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,32 @@
 Lua implementation of the [libcoraza](https://github.com/corazawaf/libcoraza) for modsecurity Web Application Firewall.
 
 
-## Installation
+## dependence
 
-```bash
-luarocks install lua-resty-t1k
+### 1. libcoraza-nginx
+1. clone the repository
+`git clone https://github.com/potats0/coraza.git`
+
+2. Build the source && Installation
 ```
+cd coraza
+./build.sh
+./configure
+make
+sudo make install
+```
+`libcoraza.so` will be installed at `/usr/local/lib`
+
+### 2. Coreruleset
+coreruleset is an opensource waf rules.
+1. clone the repository
+`git clone https://github.com/coreruleset/coreruleset`
+
+### 3. lua-resty-coraza
+```bash
+opm get potats0/lua-resty-coraza
+```
+
 
 ## Synopsis
 
@@ -53,4 +74,6 @@ if you need more log for debug, please turn on the debug on nginx.
 
 ```
 error_log logs/error.log debug;
-```
\ No newline at end of file
+```
+
+the matched rules log will be logged at `ngx.ctx.coraza_msg` by `coraza.do_log()`
\ No newline at end of file