Improve the main README.md and the ROADMAP.md

Author: habedi

README.md

@@ -21,16 +21,18 @@ A lightweight, fast web framework for Zig
 ---
 
 Helium is a small, configurable web framework for Zig programming language.
-It provides the basic building blocks for creating fast and efficient web applications and services in Zig by composing
-a set of reusable components.
-Helium follows a micro-framework design philosophy, with a small core feature set that could be extended via optional
+It provides the essential building blocks for creating fast and efficient web applications and services in Zig by
+composing a set of reusable components.
+Helium follows a micro-framework design philosophy with a small core feature set that could be extended via optional
 middleware and utilities.
 
-- **Nothing Hardcoded**: All features are opt-in and configurable
-- **Composable**: Build your application from small, reusable components
-- **Flexible**: Use what you need, ignore what you don't
-- **Minimal Core**: A small, focused API that doesn't get in your way
-- **Zero Magic**: Explicit and predictable behavior
+### Features
+
+- Fully configurable and extensible components
+- Build your application from small, reusable components
+- Use what you need, ignore what you don't
+- A small, focused API that doesn't get in your way
+- Explicit and predictable behavior with minimal hidden states
 
 ### Core Features
 

ROADMAP.md

@@ -1,31 +1,25 @@
-## Helium Web Framework Roadmap
+## Feature Roadmap
 
-This document outlines the development roadmap for Helium, a lightweight, configurable micro web framework for Zig.
+This document includes the roadmap for the Helium web framework.
+It outlines features to be implemented and their current status.
 
 > [!IMPORTANT]
-> This roadmap is a living document and may change based on community feedback and evolving needs.
-
-### Philosophy & Design Goals
-
-Helium is designed as a **micro-framework** with these core principles:
-- **Configurability First**: Nothing is hardcoded; everything is opt-in and customizable
-- **Minimal Core**: Keep the core API small and focused
-- **Composability**: Features should be independent and composable
-- **Zero Magic**: Explicit, predictable behavior without hidden abstractions
-- **Performance**: Efficient use of resources with multiple concurrency models
+> This roadmap is a work in progress and is subject to change.
 
 ---
 
-### ✅ Implemented Features
+### Implemented Features
 
 #### Core Framework
+
 - [x] Generic `App` type with custom context support
 - [x] Type-safe request handlers and middleware
 - [x] Configurable memory allocator per application
 - [x] Custom error handler support
 - [x] Multi-mode server (thread pool and event-driven I/O)
 
 #### Routing System
+
 - [x] Express.js-like routing API
 - [x] HTTP method support (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
 - [x] Dynamic route parameters (e.g., `/users/:id`)
@@ -34,19 +28,22 @@ Helium is designed as a **micro-framework** with these core principles:
 - [x] Tree-based router for efficient path matching
 
 #### Middleware System
+
 - [x] Global middleware (applied to all routes)
 - [x] Group-scoped middleware (applied to route groups)
 - [x] Route-specific middleware chains
 - [x] Middleware composition with `next()` pattern
 - [x] Type-safe middleware signatures
 
 #### Built-in Utilities
+
 - [x] CORS middleware (allow-all origins)
 - [x] Static file server with path traversal protection
 - [x] Common log format middleware with timing
 - [x] JSON response helpers
 
 #### Request/Response
+
 - [x] Request parameter access (path params, query params)
 - [x] Request body string access
 - [x] Response status code setting
@@ -56,9 +53,10 @@ Helium is designed as a **micro-framework** with these core principles:
 
 ---
 
-### 📋 Planned Features
+### Planned Features
 
 #### 1. Enhanced Routing
+
 - [ ] Route wildcards (e.g., `/files/*`)
 - [ ] Route matching with regular expressions
 - [ ] Route priority/ordering control
@@ -67,6 +65,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Automatic OPTIONS handling per route
 
 #### 2. Request Handling
+
 - [ ] Multipart form data parsing
 - [ ] File upload handling
 - [ ] Request body size limits (configurable)
@@ -76,6 +75,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Custom body parsers (pluggable)
 
 #### 3. Response Enhancements
+
 - [ ] Response streaming API for large payloads
 - [ ] Request body streaming for file uploads
 - [ ] Template rendering support (pluggable)
@@ -86,6 +86,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Chunked transfer encoding
 
 #### 4. Middleware Ecosystem
+
 - [ ] Configurable CORS middleware (custom origins, methods, headers)
 - [ ] Rate limiting middleware
 - [ ] Authentication middleware (JWT, Bearer, Basic Auth)
@@ -99,6 +100,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Circuit breaker pattern
 
 #### 5. Performance & Scaling
+
 - [ ] Connection pooling
 - [ ] Request/response pooling
 - [ ] Zero-copy optimizations
@@ -108,20 +110,23 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Metrics and monitoring hooks
 
 #### 6. Error Handling
+
 - [ ] Error recovery middleware
 - [ ] Detailed error responses (development mode)
 - [ ] Error logging integration points
 - [ ] Panic recovery
 - [ ] Structured error types
 
 #### 7. Testing & Development
+
 - [ ] Test client for integration testing
 - [ ] Mock request/response builders
 - [ ] Development mode with hot reload (external tool integration)
 - [ ] Request/response logging levels
 - [ ] Debug middleware
 
 #### 8. Security
+
 - [ ] HTTPS/TLS support
 - [ ] Certificate management helpers
 - [ ] Input sanitization helpers
@@ -131,6 +136,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Request size limits
 
 #### 9. Documentation & Examples
+
 - [x] Basic examples (simple server, error handling)
 - [x] Route grouping example
 - [ ] REST API example
@@ -144,6 +150,7 @@ Helium is designed as a **micro-framework** with these core principles:
 - [ ] Migration guide from other frameworks
 
 #### 10. Ecosystem Integration
+
 - [ ] Database connection pooling patterns
 - [ ] ORM integration examples
 - [ ] Message queue integration patterns
@@ -153,7 +160,7 @@ Helium is designed as a **micro-framework** with these core principles:
 
 ---
 
-### 🎯 Future Considerations
+### Future Considerations
 
 These features are being considered but not yet prioritized:
 
@@ -168,13 +175,3 @@ These features are being considered but not yet prioritized:
 - Service mesh integration
 - Admin panel/dashboard
 - Plugin system architecture
-
----
-
-### Contributing
-
-Want to help implement a feature? Check our [CONTRIBUTING.md](CONTRIBUTING.md) guide!
-
-### Feedback
-
-Have suggestions for the roadmap? Open an issue or discussion on our [GitHub repository](https://github.com/CogitatorTech/helium).

examples/README.md

@@ -1,6 +1,8 @@
-## Helium's Examples
+## Helium Examples
+
+| # | File                                       | Description                                        |
+|---|--------------------------------------------|----------------------------------------------------|
+| 1 | [e1_simple_example.zig](e1_simple_example.zig) | A very simple web application made with Helium     |
+| 2 | [e2_error_handling.zig](e2_error_handling.zig) | Shows custom error handling with different error types |
+| 3 | [e3_route_groups.zig](e3_route_groups.zig) | Shows route grouping and group-level middleware usage |
 
-| **#** | **File**                                       | **Description**                           |
-|-------|------------------------------------------------|-------------------------------------------|
-| 1     | [e1_simple_example.zig](e1_simple_example.zig) | A simple web application made with Helium |
-| 2     | [e2_error_handling.zig](e2_error_handling.zig) | Demonstrates custom error handling with different error types |