From bfeed277cec3e72628d7e67e061eb64d86ba3ba8 Mon Sep 17 00:00:00 2001 From: Amir Karimi <35371206+AMK9978@users.noreply.github.com> Date: Sun, 24 Nov 2024 17:55:07 +0330 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 526e5be..c85712e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# LLM Guardian Central Unit +# LLM Guardian Kernel A plug-and-play end-to-end LLM guardian for seamless integration. -The central unit is in charge of fanning out requests to the connected -security plugins based on user, and collecting their responses to judge whether a prompt -is malicious or benign. You can also use the central unit as a rate limiter, authentication unit, or quota management. +The kernel is in charge of fanning out requests to the connected +security plugins based on user and collecting their responses to judge whether a prompt +is malicious or benign. You can also use the kernel as a rate limiter, authentication unit, or quota management. + +## Features & Qualities +- Written in Golang to be super-fast and production-ready +- Microkernel architecture: Open to extension +- Rate limiter +- Supports both HTTP/1.1 and gRPC plugins with reusable gPRC clients +- Define tasks and apply them to users/groups +- SOLID obedient and Database agnostic (MongoDB by default) +- Test covered, CI, linter ## Get Started @@ -18,6 +27,9 @@ The guardian system uses a micro-kernel architecture designed by the idea of ext ![Architecture](./docs/arch.jpg) +## Citation +If you use this application, please cite it using the "Cite this repository" above. + ## Contribution I am always welcome to your contributions. Open an issue and/or open a PR accordingly. This system is designed and the central unit is developed by Amir Karimi (@amk9978).