Improve the logo

Author: habedi

.gitignore

@@ -98,3 +98,4 @@ uv.lock
 public/
 site/
 *.a
+docs/api

README.md

@@ -14,64 +14,33 @@
 [![Release](https://img.shields.io/github/release/CogitatorTech/helium.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/helium/releases/latest)
 [![License](https://img.shields.io/badge/license-MIT-007ec6?label=license&style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/CogitatorTech/helium/blob/main/LICENSE)
 
-A lightweight, fast web framework for Zig
+A micro web framework for Zig
 
 </div>
 
 ---
 
-Helium is a small, configurable web framework for Zig programming language.
-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
+Helium is a small, configurable web framework for the Zig programming language.
+It aims to provide the essential building blocks needed for creating fast and efficient web applications and services in
+Zig without getting in the way of your application's logic.
+
+Helium follows a micro-framework design philosophy with a small core feature set that can be extended via optional
 middleware and utilities.
+It aims to be lightweight and easy to use, while still providing the necessary building blocks for building complex web
+applications by allowing users to compose their applications from reusable components.
 
 ### 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
-
-**Routing & Request Handling**
-
-- Express.js-like routing with HTTP method support (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS)
-- Dynamic route parameters (e.g., `/users/:id`)
-- Query parameter parsing
-- Route grouping with shared prefixes
-- Request body parsing
-
-**Middleware System**
-
-- Global middleware applied to all routes
-- Group-scoped middleware for route collections
-- Route-specific middleware chains
-- Custom middleware support with simple function signatures
-
-**Server Modes**
-
-- Thread pool mode for high concurrency
-- Minimal thread pool with event-driven I/O
-- Configurable worker thread counts
-
-**Built-in Utilities** (all optional)
-
-- **CORS middleware**: Cross-origin resource sharing (allow-all)
-- **Static file serving**: Secure file server with path traversal protection
-- **Logging middleware**: Common log format with timing information
-- **JSON responses**: Built-in JSON serialization support
-
-**Flexibility**
-
-- Generic context type for application state
-- Custom error handlers per application
-- Memory allocator control
-- Type-safe handler functions
+-   Supports application type with custom context
+-   Supports Type-safe request handlers and middleware
+-   Supports configurable memory allocator and error handlers
+-   Provides routing API with dynamic parameters and query parsing
+-   Supports route groups with shared path prefixes
+-   Provides middleware for global, group, and route-specific logic
+-   Supports JSON and plain text response serialization
+-   Supports static file serving with path traversal protection
 
-See the [ROADMAP.md](ROADMAP.md) for the list of implemented and planned features.
+See the [ROADMAP.md](ROADMAP.md) for the full list of implemented and planned features.
 
 > [!IMPORTANT]
 > Helium is in early development, so bugs and breaking changes are expected.

ROADMAP.md

@@ -8,7 +8,9 @@ It outlines features to be implemented and their current status.
 
 ---
 
-### Implemented Features
+### Features
+
+The following features are currently being worked on or planned for future releases.
 
 #### Core Framework
 
@@ -21,11 +23,17 @@ It outlines features to be implemented and their current status.
 #### 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`)
+- [x] HTTP method support (GET, POST, PUT, DELETE, PATCH, HEAD, and OPTIONS)
+- [x] Dynamic route parameters (like `/users/:id`)
 - [x] Query parameter parsing
 - [x] Route grouping with shared path prefixes
 - [x] Tree-based router for efficient path matching
+- [ ] Route wildcards (like `/files/*`)
+- [ ] Route matching with regular expressions
+- [ ] Route priority and ordering control
+- [ ] Nested route groups
+- [ ] Route metadata and tagging
+- [ ] Automatic OPTIONS handling per route
 
 #### Middleware System
 
@@ -34,38 +42,27 @@ It outlines features to be implemented and their current status.
 - [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
+- [ ] Configurable CORS middleware (custom origins, methods, and headers)
+- [ ] Rate limiting middleware
+- [ ] Authentication middleware (JWT, Bearer, and Basic Auth)
+- [ ] Session management middleware
+- [ ] Cookie parsing and management
+- [ ] Request ID tracking
+- [ ] Body parser middleware (JSON, form-urlencoded, and multipart)
+- [ ] CSRF protection
+- [ ] Security headers middleware (helmet-style)
+- [ ] Request timeout middleware
+- [ ] Circuit breaker pattern
+- [ ] Error recovery middleware
+- [ ] Panic recovery
+- [ ] Debug middleware
 
-#### Request/Response
+#### Request Handling
 
-- [x] Request parameter access (path params, query params)
+- [x] Request parameter access (path and query parameters)
 - [x] Request body string access
-- [x] Response status code setting
-- [x] Response header management
-- [x] JSON response serialization
-- [x] Plain text responses
-
----
-
-### Planned Features
-
-#### 1. Enhanced Routing
-
-- [ ] Route wildcards (e.g., `/files/*`)
-- [ ] Route matching with regular expressions
-- [ ] Route priority/ordering control
-- [ ] Nested route groups
-- [ ] Route metadata and tagging
-- [ ] Automatic OPTIONS handling per route
-
-#### 2. Request Handling
-
 - [ ] Multipart form data parsing
 - [ ] File upload handling
 - [ ] Request body size limits (configurable)
@@ -74,58 +71,53 @@ It outlines features to be implemented and their current status.
 - [ ] Request validation helpers
 - [ ] Custom body parsers (pluggable)
 
-#### 3. Response Enhancements
+#### Response Handling
 
+- [x] Response status code setting
+- [x] Response header management
+- [x] JSON response serialization
+- [x] Plain text responses
 - [ ] Response streaming API for large payloads
 - [ ] Request body streaming for file uploads
 - [ ] Template rendering support (pluggable)
-- [ ] Response compression (gzip, deflate, brotli)
+- [ ] Response compression (gzip, deflate, or brotli)
 - [ ] ETag support for caching
-- [ ] Conditional requests (If-None-Match, If-Modified-Since)
+- [ ] Conditional requests (If-None-Match and If-Modified-Since)
 - [ ] Server-Sent Events (SSE) support
 - [ ] Chunked transfer encoding
 
-#### 4. Middleware Ecosystem
+#### Static File Serving
 
-- [ ] Configurable CORS middleware (custom origins, methods, headers)
-- [ ] Rate limiting middleware
-- [ ] Authentication middleware (JWT, Bearer, Basic Auth)
-- [ ] Session management middleware
-- [ ] Cookie parsing and management
-- [ ] Request ID tracking
-- [ ] Body parser middleware (JSON, form-urlencoded, multipart)
-- [ ] CSRF protection
-- [ ] Security headers middleware (helmet-style)
-- [ ] Request timeout middleware
-- [ ] Circuit breaker pattern
+- [x] Static file server with path traversal protection
+- [ ] ETag support for static files
+- [ ] Range request support for partial content
+- [ ] Directory listing (optional)
+
+#### Error Handling
+
+- [x] Custom error handler support
+- [ ] Detailed error responses (development mode)
+- [ ] Error logging integration points
+- [ ] Structured error types
 
-#### 5. Performance & Scaling
+#### Performance & Scaling
 
 - [ ] Connection pooling
-- [ ] Request/response pooling
+- [ ] Request and response pooling
 - [ ] Zero-copy optimizations
 - [ ] HTTP keep-alive connection management
 - [ ] Graceful shutdown support
 - [ ] Health check endpoints
 - [ ] 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
+#### Testing & Development
 
 - [ ] Test client for integration testing
-- [ ] Mock request/response builders
+- [ ] Mock request and response builders
 - [ ] Development mode with hot reload (external tool integration)
-- [ ] Request/response logging levels
-- [ ] Debug middleware
+- [ ] Request and response logging levels
 
-#### 8. Security
+#### Security
 
 - [ ] HTTPS/TLS support
 - [ ] Certificate management helpers
@@ -135,9 +127,9 @@ It outlines features to be implemented and their current status.
 - [ ] Rate limiting by IP/user
 - [ ] Request size limits
 
-#### 9. Documentation & Examples
+#### Documentation & Examples
 
-- [x] Basic examples (simple server, error handling)
+- [x] Basic examples (simple server and error handling)
 - [x] Route grouping example
 - [ ] REST API example
 - [ ] WebSocket chat example
@@ -149,14 +141,14 @@ It outlines features to be implemented and their current status.
 - [ ] Best practices guide
 - [ ] Migration guide from other frameworks
 
-#### 10. Ecosystem Integration
+#### Ecosystem Integration
 
 - [ ] Database connection pooling patterns
 - [ ] ORM integration examples
 - [ ] Message queue integration patterns
-- [ ] Cache integration (Redis, Memcached)
+- [ ] Cache integration (Redis and Memcached)
 - [ ] Logging framework integration
-- [ ] OpenTelemetry/tracing support
+- [ ] OpenTelemetry and tracing support
 
 ---
 

build.zig

@@ -4,90 +4,59 @@ const fs = std.fs;
 pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
-
-    // --- Library Setup ---
     const lib_source = b.path("src/lib.zig");
-
-    // This creates the "helium" module, makes it available to other packages,
-    // and returns a reference to it.
     const lib_module = b.addModule("helium", .{
         .root_source_file = lib_source,
         .target = target,
         .optimize = optimize,
     });
-
-    // Then, we use the same module for the library artifact.
     const lib = b.addLibrary(.{
         .name = "helium",
         .root_module = lib_module,
     });
     b.installArtifact(lib);
-
-    // --- Docs Setup ---
     const docs_step = b.step("docs", "Generate API documentation");
     const doc_install_path = "docs/api";
-
-    // This command remains the same, but the directory creation can be improved.
     const gen_docs_cmd = b.addSystemCommand(&[_][]const u8{
-        b.graph.zig_exe, // Use the same zig that is running the build
+        b.graph.zig_exe,
         "build-lib",
         "src/lib.zig",
         "-femit-docs=" ++ doc_install_path,
     });
-
-    // Using `b.addSystemCommand` for `mkdir` is not portable (e.g., to Windows).
-    // For this case it is acceptable, but for broader compatibility,
-    // a RunStep with `std.fs.makeDir` would be better.
     const mkdir_cmd = b.addSystemCommand(&[_][]const u8{
         "mkdir", "-p", doc_install_path,
     });
     gen_docs_cmd.step.dependOn(&mkdir_cmd.step);
-
     docs_step.dependOn(&gen_docs_cmd.step);
-
-    // --- Test Setup ---
-    // The test runner also consumes a module now.
     const lib_unit_tests = b.addTest(.{
         .root_module = lib_module,
     });
-
     const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_lib_unit_tests.step);
-
-    // --- Example Setup ---
     const examples_path = "examples";
-    // This block gracefully handles the case where the examples directory doesn't exist.
     examples_blk: {
         var examples_dir = fs.cwd().openDir(examples_path, .{ .iterate = true }) catch |err| {
             if (err == error.FileNotFound or err == error.NotDir) break :examples_blk;
             @panic("Can't open 'examples' directory");
         };
         defer examples_dir.close();
-
         var dir_iter = examples_dir.iterate();
         while (dir_iter.next() catch @panic("Failed to iterate examples")) |entry| {
             if (!std.mem.endsWith(u8, entry.name, ".zig")) continue;
-
             const exe_name = fs.path.stem(entry.name);
             const exe_path = b.fmt("{s}/{s}", .{ examples_path, entry.name });
-
-            // Create a module for the executable.
             const exe_module = b.createModule(.{
                 .root_source_file = b.path(exe_path),
                 .target = target,
                 .optimize = optimize,
             });
-            // Add the main library as a dependency to the executable's module.
             exe_module.addImport("helium", lib_module);
-
-            // Create the executable artifact from the module.
             const exe = b.addExecutable(.{
                 .name = exe_name,
                 .root_module = exe_module,
             });
             b.installArtifact(exe);
-
             const run_cmd = b.addRunArtifact(exe);
             const run_step_name = b.fmt("run-{s}", .{exe_name});
             const run_step_desc = b.fmt("Run the {s} example", .{exe_name});
@@ -96,4 +65,3 @@ pub fn build(b: *std.Build) void {
         }
     }
 }
-

build.zig.zon

@@ -1,6 +1,6 @@
 .{
     .name = .helium,
-    .version = "0.1.0",
+    .version = "0.1.0-alpha.1",
     .fingerprint = 0x530afceb745b01bc, // Changing this has security and trust implications.
     .minimum_zig_version = "0.15.1",
     .paths = .{