3636
3737 <p >
3838 <a href="#-quick-start">Quick Start</a> •
39- <a href="https://maxluxs.github.io/Flagent">Documentation</a> •
39+ <a href="https://maxluxs.github.io/Flagent/getting-started.md ">Documentation</a> •
4040 <a href="#-key-features">Features</a> •
4141 <a href="#-sdks">SDKs</a> •
4242 <a href="#-use-cases">Use Cases</a> •
6363- ** A/B Insights** - Automated experiment analysis
6464
6565### Enterprise-Ready
66- - ** Production-Proven ** - 70 + test files, comprehensive coverage
67- - ** High Performance** - Sub-millisecond evaluation, 10k+ req/s
66+ - ** Extensive test coverage ** - 200 + test files
67+ - ** High Performance** - Low latency, high throughput (see backend PerformanceTest: >100 req/s)
6868- ** Multi-Tenancy** - Isolated environments for teams (Roadmap)
6969- ** Real-Time Updates** - SSE in Kotlin Enhanced, Go Enhanced
7070
@@ -93,8 +93,8 @@ open http://localhost:18000
9393- ✅ ** Advanced Targeting** - Segment users by attributes, percentages, or complex constraint rules
9494- ✅ ** Multi-Environment** - Separate configurations for dev, staging, and production
9595- ✅ ** Data Recorders** - Kafka, Kinesis, PubSub integration for analytics
96- - ✅ ** High Performance** - Sub-millisecond evaluation with EvalCache and TTL
97- - ✅ ** Client-Side Evaluation** - Offline-first local evaluation (< 1ms) in Kotlin Enhanced, Go Enhanced
96+ - ✅ ** High Performance** - Low-latency evaluation with EvalCache and TTL
97+ - ✅ ** Client-Side Evaluation** - Offline-first local evaluation in Kotlin Enhanced, Go Enhanced
9898- ✅ ** Real-Time Updates** - SSE for instant flag changes in Kotlin Enhanced, Go Enhanced
9999- ✅ ** Multiple Databases** - PostgreSQL, MySQL, SQLite support
100100- ✅ ** Docker Ready** - Production-ready Docker images with Compose
@@ -112,10 +112,10 @@ open http://localhost:18000
112112
113113## 📖 Documentation
114114
115- - 📖 ** [ Full Documentation ] ( https://maxluxs.github.io/Flagent ) ** - Complete guides, API reference, and examples
116- - 📖 ** [ Getting Started Guide ] ( README.md#-quick-start ) ** - Quick start and setup instructions
117- - 📖 ** [ API Documentation ] ( https://maxluxs.github.io/Flagent/api/openapi.yaml ) ** - OpenAPI specification
118- - 📖 ** [ Architecture Documentation ] ( https://maxluxs.github.io/Flagent/#/ architecture/backend ) ** - System architecture and design
115+ - 📖 ** [ Getting Started ] ( https://maxluxs.github.io/Flagent/getting-started.md ) ** - Quick start and setup
116+ - 📖 ** [ API Reference ] ( https://maxluxs.github.io/Flagent ) ** - API docs and OpenAPI
117+ - 📖 ** [ OpenAPI spec ] ( https://maxluxs.github.io/Flagent/api/openapi.yaml ) ** - OpenAPI specification
118+ - 📖 ** [ Architecture] ( https://maxluxs.github.io/Flagent/architecture/backend.md ) ** - System design
119119
120120## 🏗️ Project Structure
121121
@@ -134,7 +134,7 @@ flagent/
134134
135135### Requirements
136136- JDK 21+
137- - Gradle 9.0
137+ - Gradle 8.13 (wrapper)
138138
139139### Build
140140``` bash
@@ -213,7 +213,7 @@ Published artifacts: `shared` (KMP: root + `shared-jvm`, `shared-js`), `ktor-fla
213213
214214- ** Ktor Plugin** - [ ktor-flagent] ( ktor-flagent ) - First-class Ktor integration with middleware support
215215
216- See [ SDK Documentation ] ( https://maxluxs.github.io/Flagent ) for detailed usage guides.
216+ See [ Getting Started ] ( https://maxluxs.github.io/Flagent/getting-started.md ) and [ API Reference ] ( https://maxluxs.github.io/Flagent ) for usage guides.
217217
218218## 🛠️ Technology Stack
219219
@@ -250,7 +250,7 @@ cd Flagent
250250./gradlew :backend:run
251251```
252252
253- See [ Deployment Guide] ( https://maxluxs.github.io/Flagent/#/ deployment ) for production setup.
253+ See [ Deployment Guide] ( https://maxluxs.github.io/Flagent/deployment.md ) for production setup.
254254
255255## 🤝 Contributing
256256
@@ -260,7 +260,7 @@ We welcome contributions from the community! Flagent is built with love by devel
260260
2612611 . ** Fork the repository**
2622622 . ** Create your feature branch** (` git checkout -b feature/amazing-feature ` )
263- 3 . ** Make your changes** - Follow our [ code style guidelines] ( https://maxluxs.github.io/Flagent/#/ contributing )
263+ 3 . ** Make your changes** - Follow our [ code style guidelines] ( https://maxluxs.github.io/Flagent/contributing.md )
2642644 . ** Add tests** - Ensure your changes are well-tested
2652655 . ** Commit your changes** (` git commit -m 'Add some amazing feature' ` )
2662666 . ** Push to the branch** (` git push origin feature/amazing-feature ` )
@@ -276,7 +276,7 @@ We welcome contributions from the community! Flagent is built with love by devel
276276- ⚡ ** Performance** - Optimize evaluation speed
277277- 🧪 ** Tests** - Increase test coverage
278278
279- For more details, see our [ Contributing Guide] ( https://maxluxs.github.io/Flagent/#/ contributing ) and [ Development Setup] ( README.md#development ) .
279+ For more details, see our [ Contributing Guide] ( https://maxluxs.github.io/Flagent/contributing.md ) and [ Development Setup] ( README.md#development ) .
280280
281281## 📄 License
282282
@@ -341,9 +341,8 @@ Join our growing community of developers building better feature flag systems!
341341
342342### Get Help
343343
344- - 💬 ** [ GitHub Discussions] ( https://github.com/MaxLuxs/Flagent/discussions ) ** - Ask questions, share ideas, and connect with other users
345- - 🐛 ** [ GitHub Issues] ( https://github.com/MaxLuxs/Flagent/issues ) ** - Report bugs or request new features
346- - 📚 ** [ Documentation] ( https://maxluxs.github.io/Flagent ) ** - Comprehensive guides, API reference, and tutorials
344+ - 🐛 ** [ GitHub Issues] ( https://github.com/MaxLuxs/Flagent/issues ) ** - Ask questions, report bugs, or request features
345+ - 📚 ** [ Documentation] ( https://maxluxs.github.io/Flagent/getting-started.md ) ** - Guides and API reference
347346- 💻 ** [ Code Examples] ( samples ) ** - Real-world examples in Kotlin, Python, JavaScript, Swift, and Go
348347- 🎯 ** [ Roadmap] ( docs/roadmap.md ) ** - Our journey to becoming the best open-source feature flag platform
349348
@@ -362,7 +361,7 @@ Need help deploying Flagent in production? Want custom features or SLA guarantee
362361- 🔒 ** Priority Support** - Faster response times and dedicated Slack channel
363362- 🚀 ** Managed Hosting** (Coming Soon) - Fully managed SaaS solution
364363
365- Contact us at : ** support@flagent.io ** (Coming Soon)
364+ Contact: ** max.developer.luxs@gmail.com **
366365
367366## 🎯 Use Cases
368367
@@ -377,11 +376,11 @@ Contact us at: **support@flagent.io** (Coming Soon)
377376
378377## 📊 Performance & Scalability
379378
380- - ** Sub-millisecond latency** - Typical evaluation time under 1ms
381- - ** 10,000+ evaluations/second ** per instance
379+ - ** Low latency** - Typical evaluation under 10ms (see backend PerformanceTest)
380+ - ** High throughput ** - 100+ req/s per instance (see backend PerformanceTest)
382381- ** Horizontal scaling** - Stateless architecture supports multiple instances
383- - ** Low memory footprint ** - ~ 200MB base memory usage
384- - ** EvalCache with TTL** - Intelligent caching reduces database load by 90%
382+ - ** Modest memory** - Approximately 200MB typical base usage
383+ - ** EvalCache with TTL** - Caching significantly reduces database load
385384- ** Deterministic bucketing** - Consistent user assignments using MurmurHash3
386385
387386## 👥 Who's Using Flagent?
@@ -392,14 +391,15 @@ Flagent is trusted by teams building high-performance Kotlin applications:
392391- 🔬 ** Research Projects** - Used in academic and research environments
393392- 🏢 ** Internal Tools** - Powering feature flags for internal applications
394393
395- * Are you using Flagent in production? [ Let us know! ] ( https://github.com/MaxLuxs/Flagent/discussions/new?category=show-and-tell ) *
394+ * Are you using Flagent in production? [ Let us know] ( https://github.com/MaxLuxs/Flagent/issues ) or email max.developer.luxs@gmail.com . *
396395
397396## 🔗 Links
398397
399- - 📖 ** [ Documentation] ( https://maxluxs.github.io/Flagent ) **
400- - 🐳 ** [ Docker Hub] ( https://github.com/MaxLuxs/Flagent/pkgs/container/flagent ) **
398+ - 📖 ** [ Documentation] ( https://maxluxs.github.io/Flagent/getting-started.md ) **
399+ - 📖 ** [ API Reference] ( https://maxluxs.github.io/Flagent ) **
400+ - 🐳 ** [ Container image (GHCR)] ( https://github.com/MaxLuxs/Flagent/pkgs/container/flagent ) **
401401- 📦 ** [ Releases] ( https://github.com/MaxLuxs/Flagent/releases ) **
402- - 💬 ** [ Discussions ] ( https://github.com/MaxLuxs/Flagent/discussions ) **
402+ - 🐛 ** [ Issues ] ( https://github.com/MaxLuxs/Flagent/issues ) **
403403
404404---
405405
0 commit comments