From 4c8bd5be09719c9d05ee73d10d752df226c06fe3 Mon Sep 17 00:00:00 2001 From: Wgoeh Date: Tue, 9 Sep 2025 10:05:21 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 759ebfb..826ee4f 100644 --- a/README.md +++ b/README.md @@ -63,10 +63,18 @@ Check out our `CONTRIBUTING.md` guide to see how you can help. --- --> +--- + +## 🤝 Contributing + +We welcome contributions from the community! Please see the CONTRIBUTING.md guide for more information. + +--- + **Valkyrie: Security, forged by the community.**

-

Made with ❤️ By AllDotPy

\ No newline at end of file +

Made with ❤️ By AllDotPy

From e85cd324fb45f3e7644281aa7fa2bb20569af462 Mon Sep 17 00:00:00 2001 From: Wgoeh Date: Tue, 9 Sep 2025 10:12:15 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 826ee4f..13e3ec3 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Check out our `CONTRIBUTING.md` guide to see how you can help. ## 🤝 Contributing -We welcome contributions from the community! Please see the CONTRIBUTING.md guide for more information. +We welcome contributions from the community! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) guide for more information. --- From b7246ac55881ed693b51f6b3a473dbd3562c63d9 Mon Sep 17 00:00:00 2001 From: Wgoeh Date: Fri, 12 Sep 2025 10:30:50 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 79 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 13e3ec3..0716487 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ + +

+ + + + License + + + Python + + + GitHub commit activity + +

+ + # Valkyrie The guardian of your Pull Requests. She decides what gets to merge. @@ -17,6 +37,9 @@ Valkyrie's power comes from its crowdsourced rule set. The community continuousl **Ready to join the guard?** Contribute rules, report false positives, improve the engine. Together, we make the open-source ecosystem safer. +> ⚠️ Project Status: Active Development +Valkyrie is currently under heavy development. We're building an industrial-grade security scanner with the community. Join us to shape the future of proactive security! + --- ## 🛡️ **Why Valkyrie?** @@ -28,7 +51,53 @@ Valkyrie's power comes from its crowdsourced rule set. The community continuousl | **🧩 Crowdsourced Rules** | The value comes from the community. Share rules for any service or tool. | | **⚡ Fast & Preventive** | Blazing-fast scans designed to keep pace with development, not slow it down. | -## 🚀 **Get Started in 2 Minutes** +### ✅ Robustness & Performance (Planned) + +- Async scanning with worker limiting +- Robust error handling without interruptions +- Rule caching and optimizations +- Large project support (>10MB per file) + +### ✅ Extensibility (Planned) + +- Clean plugin system with clear interfaces +- Customizable YAML rules by the community +- Multi-cloud support (AWS, GCP, Azure, etc.) +- Extensible API for new scanners + +### ✅ Native CI/CD Integration (Planned) + +- Auto-detection of CI environments +- Standard output formats (SARIF, GitLab SAST) +- Automatic PR/MR comments +- Diff-only support for optimized scans + +### ✅ Clean Architecture (Planned) + +- Strongly typed code (mypy compatible) +- Clear separation of concerns +- Industry-standard patterns (Repository, Plugin, Strategy) + +### 🏗️ Current Development Focus + +We're currently building the foundational layers: + +- Core Scanning Engine - Async, typed, modular +- Plugin System - Extensible security checks +- Rule Repository - Community-driven patterns +- CI Integrations - GitHub Actions first + +--- + +## 🚀 Coming Soon - Planned Features +### 🔍 Multi-Layer Security Scanning + +- **Secrets Detection**: API keys, tokens, credentials with crowd-sourced patterns +- **Dependency Scanning**: SBOM generation and vulnerability detection (Vulnera plugin) +- **IAM Configuration**: Risky cloud permissions in AWS, GCP, Azure configurations +- **Custom Rules**: Community-driven detection rules for any service or framework + +## 🚀 **Get Started in 2 Minutes (When Available)** ```yaml # .github/workflows/valkyrie-scan.yml @@ -62,6 +131,11 @@ Check out our `CONTRIBUTING.md` guide to see how you can help. **Join the guard and become an open-source security legend.** --- --> +--- + +## 📜 License + +Valkyrie is licensed under AGPLv3 for open source use. Commercial licenses are available for enterprises that cannot use AGPLv3. --- @@ -71,7 +145,10 @@ We welcome contributions from the community! Please see the [CONTRIBUTING.md](CO --- -**Valkyrie: Security, forged by the community.** +**Ready to join the guard?** +Star the repo, open an issue, or submit a PR. Together, we'll build the security guardian every codebase deserves. + +**_Valkyrie: Security, forged by the community._**