galaxyrepowatch 1.0.13 → 1.0.15

package/README.md

@@ -1,25 +1,287 @@
-# 🛡️ Galaxy Repo Watch — AI Guard
+# 🛡️ Galaxy Repo Watch — AI Git Review Guard
 
-Enterprise-grade AI Git Review Guard powered by Gemini.
+Enterprise-grade AI-powered Git Review Guard powered by **Google Gemini**.
 
-⚠️ **DO NOT RUN `npm install`** ⚠️  
-This package is an automated installer. To set up AI Guard in your project, simply run the init command:
+![npm](https://img.shields.io/npm/v/galaxyrepowatch)
+![Downloads](https://img.shields.io/npm/dw/galaxyrepowatch)
+![License](https://img.shields.io/npm/l/galaxyrepowatch)
+
+---
+
+# 🚀 Quick Start
+
+> **⚠️ Do NOT install this package using `npm install`.**
+
+Galaxy Repo Watch is an automated project initializer.
+
+Simply run:
+
+```bash
+npx galaxyrepowatch init
+```
+
+The setup wizard will configure everything automatically.
+
+---
+
+# ✨ Features
+
+- 🤖 AI-powered code review using Google Gemini
+- 🔒 Detects hardcoded secrets and credentials
+- 🚫 Blocks risky commits before they reach your repository
+- ⚡ Automatic Husky Git Hook installation
+- ⚙️ Easy one-time setup
+- 📝 Reviews only staged files for faster execution
+- 🎯 Works with any Git repository
+
+---
+
+# 📦 What Happens During Setup
+
+Running:
 
 ```bash
 npx galaxyrepowatch init
 ```
 
-## What this does:
-Running the command above will automatically:
-1. Install the required dependencies.
-2. Initialize Husky in your project.
-3. Configure a `pre-commit` hook to automatically review your code before every commit.
-4. Ask for your Gemini API key (only once) and save it locally.
-5. Create a `.repowatchrc` configuration file for custom rules.
-
-## How it works:
-Every time you run `git commit`, the AI Guard will:
-- Check your code for critical syntax errors.
-- Scan for hardcoded secrets and passwords.
-- Run a Gemini 2.5 Flash AI code review on your staged changes.
-- Block the commit if the code exceeds the risk threshold (75/100).
+will automatically:
+
+- ✅ Install required dependencies
+- ✅ Initialize Husky
+- ✅ Configure a Git `pre-commit` hook
+- ✅ Ask for your Gemini API Key (only once)
+- ✅ Store your API Key securely on your local machine
+- ✅ Generate a `.repowatchrc` configuration file
+
+No manual configuration is required.
+
+---
+
+# ⚙️ How It Works
+
+Whenever you run:
+
+```bash
+git commit
+```
+
+Galaxy Repo Watch automatically reviews your staged changes before the commit is created.
+
+The AI performs the following checks:
+
+### 🔍 AI Code Review
+
+- Detects syntax issues
+- Identifies potential bugs
+- Reviews code quality
+- Suggests improvements
+- Highlights risky code changes
+
+---
+
+### 🔒 Security Scan
+
+Scans your staged files for:
+
+- API Keys
+- Passwords
+- Access Tokens
+- JWT Secrets
+- Private Keys
+- Hardcoded Credentials
+
+---
+
+### 🚫 Smart Commit Protection
+
+If the AI determines that your changes are too risky (default threshold: **75/100**), the commit will be blocked.
+
+Example:
+
+```
+❌ Commit Blocked
+
+Risk Score : 86/100
+
+Reasons:
+
+• Hardcoded API key detected
+• Potential SQL Injection
+• Critical syntax issue
+
+Please fix the issues before committing.
+```
+
+---
+
+# 📁 Configuration
+
+Galaxy Repo Watch creates a configuration file named:
+
+```
+.repowatchrc
+```
+
+Example:
+
+```json
+{
+  "provider": "gemini",
+  "model": "gemini-2.5-flash",
+  "riskThreshold": 75,
+  "blockCommit": true
+}
+```
+
+---
+
+# 🔑 Gemini API Key
+
+During setup, you'll be prompted once for your Gemini API key.
+
+```
+Enter your Gemini API Key:
+```
+
+Your API key is stored locally and is never committed to your Git repository.
+
+---
+
+# 🔄 Workflow
+
+```
+Developer
+
+      │
+      ▼
+
+git add .
+
+      │
+      ▼
+
+git commit
+
+      │
+      ▼
+
+Galaxy Repo Watch
+
+      │
+      ▼
+
+Security Scan
+
+      │
+      ▼
+
+AI Code Review
+
+      │
+      ▼
+
+───────────────
+
+Low Risk
+      │
+      ▼
+
+✅ Commit Allowed
+
+───────────────
+
+High Risk
+      │
+      ▼
+
+❌ Commit Blocked
+```
+
+---
+
+# 💻 Example Output
+
+```
+🛡 Galaxy Repo Watch
+
+Analyzing staged files...
+
+✔ Security Scan Passed
+
+✔ AI Code Review Completed
+
+Risk Score : 22/100
+
+✅ Commit Approved
+```
+
+---
+
+# 📋 Requirements
+
+- Node.js 18+
+- Git
+- Gemini API Key
+- Internet connection
+
+---
+
+# 🔒 Privacy
+
+Galaxy Repo Watch only analyzes your staged changes before a commit.
+
+- Configuration remains on your local machine.
+- API keys are never committed.
+- Only staged code is sent to the configured AI provider for review.
+
+---
+
+# 🛣 Roadmap
+
+### Current Release
+
+- ✅ AI Code Review
+- ✅ Secret Detection
+- ✅ Husky Integration
+- ✅ Commit Risk Scoring
+- ✅ Automatic Project Setup
+
+### Coming Soon
+
+- ⏳ Commit Impact Analysis
+- ⏳ Custom AI Rules
+- ⏳ Multi-AI Provider Support
+- ⏳ GitHub Actions Integration
+- ⏳ Pull Request Review
+- ⏳ VS Code Extension
+- ⏳ Team Dashboard
+
+---
+
+# 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Push your branch
+5. Open a Pull Request
+
+---
+
+# 📄 License
+
+MIT License
+
+---
+
+# ⭐ Support
+
+If Galaxy Repo Watch helps improve your development workflow, please consider giving the project a ⭐ on GitHub.
+
+Your support motivates us to continue building powerful AI tools for developers.
+
+---
+
+## Made with ❤️ by Galaxy Weblinks