Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -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!** πŸ”
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)**
Expand Down