barejs 0.1.3 → 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 xarhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,4 @@
 # 🚀 BareJS
-
 BareJS is an ultra-high-performance web engine built on the Bun runtime, designed for minimalism and the lowest possible latency.
 
 ![Benchmark Status](https://github.com/xarhang/bareJS/actions/workflows/bench.yml/badge.svg)
@@ -18,7 +17,7 @@ Performance comparison between **BareJS**, **Elysia**, and **Hono**.
 <!-- MARKER: PERFORMANCE_TABLE_START -->
 | Framework | Latency (Avg) | Speed Ratio |
 | :--- | :--- | :--- |
-| **BareJS (Your Engine)** | **-- ns/iter** | **Baseline (1.0x)** |
+| **BareJS** | **-- ns/iter** | **Baseline (1.0x)** |
 | Elysia | -- ns/iter | --x slower |
 | Hono | -- ns/iter | --x slower |
 <!-- MARKER: PERFORMANCE_TABLE_END -->
@@ -27,39 +26,102 @@ Performance comparison between **BareJS**, **Elysia**, and **Hono**.
 
 ---
 
-## ✨ Features
+✨ **Features**
+
+* **Ultra Low Latency:** Optimized to minimize processing overhead.
+* **Zero Dependency:** Built natively for security and raw speed.
+* **Optimized for Bun:** Leverages native Bun APIs for maximum performance.
+* **Memory Efficient:** Minimal heap usage and clean garbage collection.
+
+---
+
+## 📖 Documentation
+
+### ⚡ The Core Engine
+
+BareJS uses a **Static Route Compiler**. When you call `app.listen()`, BareJS transforms your routes into an optimized lookup table. This ensures  routing complexity, meaning your app stays fast whether you have 10 routes or 10,000.
+
+### 🏗️ Request Context
+
+Every handler receives a `Context` object:
+
+* `ctx.req`: The native Bun `Request`.
+* `ctx.params`: Route parameters (e.g., `/user/:id`).
+* `ctx.json(data)`: High-speed JSON response helper.
+* `ctx.body`: The validated JSON payload (available when using validators).
+
+---
+
+## 🛠 Usage Examples
+
+### 1. Basic Server
+
+```typescript
+import { BareJS } from 'barejs';
+
+const app = new BareJS();
+
+app.get('/ping', (ctx) => ctx.json({ message: 'pong' }));
+
+app.listen('0.0.0.0', 3000);
 
-- **Ultra Low Latency:** Optimized to minimize processing overhead.
-- **Zero Dependency:** Built natively for security and raw speed.
-- **Optimized for Bun:** Leverages native Bun APIs for maximum performance.
-- **Memory Efficient:** Minimal heap usage and clean garbage collection.
+```
+
+### 2. Validation (Choose Your Weapon)
+
+BareJS allows you to use different validators for different routes.
+
+```typescript
+import { BareJS } from 'barejs';
+import { typebox, zod, native } from 'barejs/middleware';
+import { Type } from '@sinclair/typebox';
+import { z } from 'zod';
+
+const app = new BareJS();
+
+// High Performance: TypeBox
+const UserSchema = Type.Object({ name: Type.String() });
+app.post('/tb', typebox(UserSchema), (ctx) => ctx.json(ctx.body));
+
+// Popular Choice: Zod
+const ZodSchema = z.object({ age: z.number() });
+app.post('/zod', zod(ZodSchema), (ctx) => ctx.json(ctx.body));
+
+// No Dependencies: Native
+app.post('/native', native({ properties: { id: { type: 'number' } } }), (ctx) => ctx.json(ctx.body));
+
+```
+
+---
 
 ## 🛠 Getting Started
 
 ### Prerequisites
-- [Bun](https://bun.sh) v1.0.0 or higher
+
+* **Bun** v1.0.0 or higher
 
 ### Installation
+
 ```bash
-bun install
+bun install barejs
+
 ```
 
 ### Running Benchmarks Locally
 
 ```bash
-bun run benchmarks/index.ts
+bun run bench
 
 ```
 
----
-
 ## 🏗 Roadmap
 
 * [x] Middleware Pattern Support (Chain Execution)
-* [x] High-Speed Static Routing (O(1) Lookup Table)
+* [x] High-Speed Static Routing ( Lookup Table)
 * [x] Schema Validation Integration
-* [ ] Full Documentation
+* [x] Modular Validator Support (TypeBox, Zod, Native)
+* [ ] Full Plugin System
 
----
+**Maintained by xarhang**
 
-*Maintained by xarhang*
+---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "barejs",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "author": "xarhang",
   "description": "High-performance JIT-specialized web framework for Bun",
   "main": "src/bare.ts",
@@ -36,6 +36,7 @@
   },
   "files": [
     "src",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ]
 }