From 04c169b8b5f583c52935c7d6b2f6fde38299fd95 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9C=89=E5=AE=89=E7=A7=91=E6=8A=80?=
 <Safe3@users.noreply.github.com>
Date: Thu, 19 Sep 2024 21:26:10 +0800
Subject: [PATCH] Update README.md

---
 docs/api/README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/api/README.md b/docs/api/README.md
index 66206e6..12cfc46 100644
--- a/docs/api/README.md
+++ b/docs/api/README.md
@@ -588,7 +588,7 @@ return _M
 
 1. 将插件文件如kafka-logger.lua 放于/uuwaf/waf/plugins/目录，并修改文件扩展名为kafka-logger.w。
 
-2. 修改/uuwaf/conf/uuwaf.conf文件，在init_by_lua_block段中waf = require("waf")下新增一行waf:use("扩展文件名")，如启用kafka-logger.lua插件的示例如下：
+2. 修改/uuwaf/conf/uuwaf.conf文件，在init_by_lua_block段中waf = require("waf")下新增一行waf:use("插件名称")，如启用kafka-logger.w插件的示例如下：
 
    ```lua
    waf = require("waf")
@@ -633,6 +633,18 @@ local log = require("waf.log")
 - 功能: 将信息写入错误日志/uuwaf/logs/error.log
 - 返回值: ``无``
 
+##### log.utf8(str)
+
+- 参数: ``可变参数，类型为字符串``
+- 功能: 将str字符编码转换为utf-8编码，防止数据写入数据库或json编码时出错
+- 返回值: ``无``
+
+##### log.getReq()
+
+- 参数: ``无``
+- 功能: 获取客户端http请求信息
+- 返回值: ``字符串``
+
 ##### log.encodeJson(obj)
 
 - 参数: ``lua table对象``