Update README.md and CONTRIBUTING.md to enhance project visibility and support for new contributors. Added PyPI version and download badges, build status, and latest release information to README.md. Introduced a section in CONTRIBUTING.md for finding good first issues, providing guidance for beginners on how to contribute effectively.

This commit is contained in:
Francisco M Humarang Jr. 2026-01-13 21:39:50 +08:00
parent d1aaa626c9
commit 2f4f2270b5
7 changed files with 266 additions and 0 deletions

View file

@ -12,6 +12,18 @@
<a href="https://github.com/flakestorm/flakestorm">
<img src="https://img.shields.io/github/stars/flakestorm/flakestorm?style=social" alt="GitHub Stars">
</a>
<a href="https://pypi.org/project/flakestorm/">
<img src="https://img.shields.io/pypi/v/flakestorm.svg" alt="PyPI version">
</a>
<a href="https://pypi.org/project/flakestorm/">
<img src="https://img.shields.io/pypi/dm/flakestorm.svg" alt="PyPI downloads">
</a>
<a href="https://github.com/flakestorm/flakestorm/actions">
<img src="https://img.shields.io/github/actions/workflow/status/flakestorm/flakestorm/ci.yml?branch=main" alt="Build Status">
</a>
<a href="https://github.com/flakestorm/flakestorm/releases">
<img src="https://img.shields.io/github/v/release/flakestorm/flakestorm" alt="Latest Release">
</a>
</p>
---
@ -162,6 +174,13 @@ That's it! You'll get a robustness score and detailed report showing how your ag
## Roadmap
See what's coming next! Check out our [Roadmap](ROADMAP.md) for upcoming features including:
- 🚀 Pattern Engine Upgrade with 110+ Prompt Injection Patterns and 52+ PII Detection Patterns
- ☁️ Cloud Version enhancements (scalable runs, team collaboration, continuous testing)
- 🏢 Enterprise features (on-premise deployment, custom patterns, compliance certifications)
## Documentation
### Getting Started