Skip to content

Commit a728dd0

Browse files
authored
Update README.md (#19)
* Update README.md * Update README.md * Update README.md
1 parent 9c99c66 commit a728dd0

File tree

1 file changed

+79
-2
lines changed

1 file changed

+79
-2
lines changed

README.md

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
2+
<p align="center">
3+
<!-- <a href="https://pypi.org/project/FletXr/">
4+
<img src="https://img.shields.io/pypi/v/FletXr" alt="PyPI Version" />
5+
</a> -->
6+
<!-- <a href="https://pepy.tech/project/FletXr">
7+
<img src="https://static.pepy.tech/badge/FletXr" alt="Downloads" />
8+
</a> -->
9+
<a href="LICENSE">
10+
<img src="https://img.shields.io/badge/License-AGPLv3-blue.svg" alt="License" />
11+
</a>
12+
<a href="">
13+
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python" />
14+
</a>
15+
<a href="https://github.com/AllDotPy/Valkyrie">
16+
<img src="https://img.shields.io/github/commit-activity/m/AllDotPy/Valkyrie" alt="GitHub commit activity" />
17+
</a>
18+
</p>
19+
20+
121
# Valkyrie
222
The guardian of your Pull Requests. She decides what gets to merge.
323

@@ -17,6 +37,9 @@ Valkyrie's power comes from its crowdsourced rule set. The community continuousl
1737

1838
**Ready to join the guard?** Contribute rules, report false positives, improve the engine. Together, we make the open-source ecosystem safer.
1939

40+
> ⚠️ Project Status: Active Development
41+
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!
42+
2043
---
2144

2245
## 🛡️ **Why Valkyrie?**
@@ -28,7 +51,53 @@ Valkyrie's power comes from its crowdsourced rule set. The community continuousl
2851
| **🧩 Crowdsourced Rules** | The value comes from the community. Share rules for any service or tool. |
2952
| **⚡ Fast & Preventive** | Blazing-fast scans designed to keep pace with development, not slow it down. |
3053

31-
## 🚀 **Get Started in 2 Minutes**
54+
### ✅ Robustness & Performance (Planned)
55+
56+
- Async scanning with worker limiting
57+
- Robust error handling without interruptions
58+
- Rule caching and optimizations
59+
- Large project support (>10MB per file)
60+
61+
### ✅ Extensibility (Planned)
62+
63+
- Clean plugin system with clear interfaces
64+
- Customizable YAML rules by the community
65+
- Multi-cloud support (AWS, GCP, Azure, etc.)
66+
- Extensible API for new scanners
67+
68+
### ✅ Native CI/CD Integration (Planned)
69+
70+
- Auto-detection of CI environments
71+
- Standard output formats (SARIF, GitLab SAST)
72+
- Automatic PR/MR comments
73+
- Diff-only support for optimized scans
74+
75+
### ✅ Clean Architecture (Planned)
76+
77+
- Strongly typed code (mypy compatible)
78+
- Clear separation of concerns
79+
- Industry-standard patterns (Repository, Plugin, Strategy)
80+
81+
### 🏗️ Current Development Focus
82+
83+
We're currently building the foundational layers:
84+
85+
- Core Scanning Engine - Async, typed, modular
86+
- Plugin System - Extensible security checks
87+
- Rule Repository - Community-driven patterns
88+
- CI Integrations - GitHub Actions first
89+
90+
---
91+
92+
## 🚀 Coming Soon - Planned Features
93+
### 🔍 Multi-Layer Security Scanning
94+
95+
- **Secrets Detection**: API keys, tokens, credentials with crowd-sourced patterns
96+
- **Dependency Scanning**: SBOM generation and vulnerability detection (Vulnera plugin)
97+
- **IAM Configuration**: Risky cloud permissions in AWS, GCP, Azure configurations
98+
- **Custom Rules**: Community-driven detection rules for any service or framework
99+
100+
## 🚀 **Get Started in 2 Minutes (When Available)**
32101

33102
```yaml
34103
# .github/workflows/valkyrie-scan.yml
@@ -62,6 +131,11 @@ Check out our `CONTRIBUTING.md` guide to see how you can help.
62131
**Join the guard and become an open-source security legend.**
63132

64133
--- -->
134+
---
135+
136+
## 📜 License
137+
138+
Valkyrie is licensed under AGPLv3 for open source use. Commercial licenses are available for enterprises that cannot use AGPLv3.
65139

66140
---
67141

@@ -71,7 +145,10 @@ We welcome contributions from the community! Please see the [CONTRIBUTING.md](CO
71145

72146
---
73147

74-
**Valkyrie: Security, forged by the community.**
148+
**Ready to join the guard?**
149+
Star the repo, open an issue, or submit a PR. Together, we'll build the security guardian every codebase deserves.
150+
151+
**_Valkyrie: Security, forged by the community._**
75152

76153
<br>
77154
<p align = 'center'>

0 commit comments

Comments
 (0)