feat: enrich the README.md file

AMK9978 · Nov 18, 2024 · 97b4ab1 · 97b4ab1
1 parent 98f81e6
commit 97b4ab1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
-# LLM Guardian
-A secure end-to-end LLM guardian for seamless integration
+# LLM Guardian Central Unit
+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.
+
 
 ## Get Started
 Docker:
@@ -9,8 +13,12 @@ docker-compose up --build -d
 ```
 
 ## Architecture
+The guardian system uses a micro-kernel architecture designed by the idea of extension in mind:
+
+![Architecture](./docs/arch.jpg)
 
 
 ## 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).
 
-## Acknowledgement
diff --git a/docs/arch.jpg b/docs/arch.jpg