From b9a4ba84777716a63f075b906e063a2db7388564 Mon Sep 17 00:00:00 2001
From: krishna fattepurkar <krishnafattepurkar@gmail.com>
Date: Fri, 2 Jan 2026 15:18:22 +0530
Subject: [PATCH] docs: add QUICKSTART.md guide and link from README

- Add 60-second quick start guide with practical examples
- Show how to install, test, and use ShieldCommit
- Include troubleshooting tips
- Link from README for better discoverability
---
 QUICKSTART.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md     |  2 ++
 2 files changed, 67 insertions(+)
 create mode 100644 QUICKSTART.md

diff --git a/QUICKSTART.md b/QUICKSTART.md
new file mode 100644
index 0000000..cdb64c7
--- /dev/null
+++ b/QUICKSTART.md
@@ -0,0 +1,65 @@
+# QuickStart Guide - ShieldCommit
+
+Get started with ShieldCommit in **60 seconds**.
+
+## 🚀 Installation
+
+```bash
+pip install shieldcommit
+```
+
+## 📋 Basic Usage
+
+### 1. Install as Git Hook
+```bash
+cd your-project
+shieldcommit install
+```
+
+### 2. Try a Commit
+```bash
+# Add a file
+echo "api_key = 'AKIAAAAAAAAAAAAAAAAA'" > config.py
+git add config.py
+
+# Try to commit
+git commit -m "Add config"
+# ❌ Blocked! Secret detected ✅
+```
+
+### 3. Remove the Secret
+```bash
+rm config.py
+git reset
+git commit -m "Add config" --allow-empty
+# ✅ Success!
+```
+
+## 🔒 What It Detects
+
+✅ **AWS Keys** (AKIA*, Secret Keys)  
+✅ **API Keys** (Stripe, GitHub, Google, etc.)  
+✅ **Passwords & Tokens**  
+✅ **Private Keys** (RSA, EC, PGP)  
+✅ **Database Credentials**  
+✅ **Slack/Discord Webhooks**  
+
+## 📚 Learn More
+
+- Full docs: See [README.md](README.md)
+- Contributing: See [CONTRIBUTING.md](CONTRIBUTING.md)
+- Branching: See [BRANCHING.md](BRANCHING.md)
+
+## ❓ Troubleshooting
+
+**Hook not working?**
+```bash
+shieldcommit install  # Reinstall
+```
+
+**False positive?**
+Check [README.md - Smart False Positive Prevention](README.md#smart-false-positive-prevention)
+
+---
+
+**Happy secure committing!** 🔐
diff --git a/README.md b/README.md
index 34112ea..b49657e 100644
--- a/README.md
+++ b/README.md
@@ -201,6 +201,8 @@ Verify installation:
 shieldcommit --help
 ```
 
+**👉 New to ShieldCommit?** Start with [QUICKSTART.md](QUICKSTART.md) for a 60-second setup!
+
 ## 🔧 Getting Started (Quick Setup)
 
 **2️⃣ Initialize a Git repository (if not already)**