diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..28d4d46 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Denis Ivanov + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..09007a7 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# โš“ L-36: Ultra-Fast Sharded Versioning Engine + +**L-36** is a high-performance, in-memory data store with native versioning support, specifically engineered for extreme write-heavy workloads and real-time diffing. + +[![Go Version](https://img.shields.io/badge/go-1.26-blue.svg)](https://go.dev) +[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos-lightgrey.svg)](https://github.com) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org) + +## ๐Ÿš€ Performance Benchmarks +*Tested on Ubuntu Latest (GitHub Actions) with 2 vCPUs:* + + +| Metric | Throughput | Latency (avg) | +| :--- | :--- | :--- | +| **Page Creation (Baseline)** | **18,600+ RPS** | ~54ยตs | +| **Heavy Lifecycle (with Diffs)** | **11,500+ RPS** | ~90ยตs | + +> **Note:** L-36 is a compute-bound engine. Performance scales linearly with CPU core count. On a 16-core machine, expected throughput exceeds **80,000+ RPS**. + +## ๐Ÿ›  Core Architecture +L-36's battleship-grade performance is built on four architectural pillars: + +1. **36-Way Horizontal Sharding**: Data is distributed across 36 independent shards. This eliminates global mutex contention, allowing massive parallel access on multi-core systems. +2. **Reverse Delta Storage**: We store the latest version in full and a chain of backward patches (Diffs). This provides O(1) access to current data while minimizing RAM footprint. +3. **Advanced Diff Engine**: Powered by optimized Google DMP (Diff-Match-Patch) with row-level pre-processing and custom memoization. +4. **Parallel Persistence**: Each of the 36 shards flushes to its own independent JSON file. This "36-Safe" approach ensures asynchronous, non-blocking I/O operations. + +## ๐Ÿ“ฆ Installation & Usage + +**Clone the repository** +```bash +git clone https://github.com/DenQ/L36.git +``` + +**Install dependencies** +```bash +make install +``` + +**Run the engine** +```bash +make run +``` + +## โš–๏ธ License + +Distributed under the MIT License. See `LICENSE` for more information. + +--- +Copyright (c) 2026 Denis Ivanov