From 5ead76211e485cbbc8e0788d01f719af3d3bd337 Mon Sep 17 00:00:00 2001 From: Aadit Agrawal Date: Thu, 7 Nov 2024 07:02:36 +0530 Subject: [PATCH] Add README.md --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b0dcf3 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# 🔒 LLM Prompt Injection & Jailbreaking Demo 🔓 + +An interactive command-line presentation demonstrating Large Language Model (LLM) prompt injection and jailbreaking techniques, security implications, and mitigation strategies. + +## 🚀 Features + +- Rich, animated terminal-based presentation +- Live demonstration of prompt injection +- Interactive slides covering: + - LLM Prompt Injection basics + - Jailbreaking techniques + - Security implications + - Mitigation strategies +- Real-time code examples +- Dynamic terminal resizing support + +## 📋 Prerequisites + +- Python 3.7+ +- Terminal with support for rich text and Unicode characters + +## 🛠️ Installation + +1. Clone this repository + +2. Install required dependencies: +```bash +pip install rich shutil +``` + +## 🎮 Usage + +Run the demonstration: +```bash +python demo.py +``` + +- Press `Ctrl+C` to exit the presentation at any time +- The presentation will automatically cycle through all slides +- Terminal window should be at least 80x24 for optimal viewing + +## ⚠️ Disclaimer + +This demonstration is for educational purposes only. The code examples and techniques shown should not be used for malicious purposes. Always follow ethical guidelines and legal requirements when working with AI systems. + +## 🔧 Technical Details + +The presentation uses the following Python packages: +- `rich`: For terminal formatting and styling +- `shutil`: For terminal size detection +- Built-in Python libraries for system operations + +## 📄 License + +This project is licensed under the MIT License - see the LICENSE file for details. + +## 🙏 Acknowledgments + +- Rich library developers +- LLM security research community \ No newline at end of file