Skip to content

Commit f7c000a

Browse files
committed
feat: add SVG project banner and update GitHub profile README with new branding.
1 parent 4af1c00 commit f7c000a

2 files changed

Lines changed: 268 additions & 8 deletions

File tree

branding/sqloot-banner.svg

Lines changed: 189 additions & 0 deletions
Loading

profile/README.md

Lines changed: 79 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,91 @@
1-
# SQLoot
1+
<div align="center">
2+
<img src="../branding/sqloot-banner.svg" alt="SQLoot banner" width="100%" style="max-width: 900px;" />
3+
</div>
4+
5+
<p align="center">
6+
<strong>Local-First | Lab | E2EE | Infra | Benchmarks | Tools | CLI | Adapters | CRDT Sync | Relays</strong><br />
7+
Public rollout is in progress (updated March 1, 2026).
8+
</p>
9+
10+
<p align="center">
11+
<img src="https://img.shields.io/badge/Public_rollout-WIP-f59e0b?style=flat-square" alt="Public rollout WIP" />
12+
<img src="https://img.shields.io/badge/Built_on-Evolu-1f6feb?style=flat-square" alt="Foundation Evolu" />
13+
<img src="https://img.shields.io/badge/Compatibility-SQLite-0ea5e9?style=flat-square" alt="SQLite compatibility" />
14+
<img src="https://img.shields.io/badge/Bun-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" />
15+
</p>
16+
17+
## ⚡ Why SQLoot
18+
19+
- 🔒 Sovereign-by-design local-first data infrastructure.
20+
- ⚙️ Bun-first and SQLite-compatible runtime direction.
21+
- 📊 Evidence-driven engineering via reproducible benchmarks.
22+
- 🧩 Evolu-compatible now.
23+
24+
## 🤝 Foundation: Evolu
25+
26+
SQLoot currently runs on top of an Evolu-based baseline. Our immediate strategy is to preserve upstream compatibility, ship measurable improvements in our fork, and upstream changes where applicable.
27+
28+
- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu)
29+
- Upstream docs: [evolu.dev](https://www.evolu.dev)
30+
- SQLoot baseline fork: [SQLoot/evolu-plan-b](https://github.com/SQLoot/evolu-plan-b)
231

3-
Open-source infrastructure for intelligent data management.
32+
Credit where it belongs: huge respect to [evoluhq](https://github.com/evoluhq) and [@steida](https://github.com/steida) for creating Evolu and moving the local-first ecosystem forward.
433

5-
> 🚧 **Coming Soon** - Repositories are currently private during development.
34+
## 🧱 What SQLoot Is Building
635

7-
## Contributing
36+
| Track | Role | Current State |
37+
|---|---|---|
38+
| `evolu-plan-b` | Evolu-compatible Bun + Biome baseline | Public rollout |
39+
| `core` | SQLoot-native runtime foundations (Rust, Zig) | Planning |
40+
| `bench-suite` | Reproducible benchmark harness | WIP |
41+
| `relays` | Evolu-compatible relay implementations (TS, Rust, BEAM, Elysia) | WIP |
42+
| `lootbox` | CLI umbrella & tools (Rust) | WIP |
43+
| `blind-cloud` | Encrypted cloud transport experiments (vault/relay/repacker) | Research |
44+
| `local-first` | Community forum, blog, wiki, guides | TBD |
45+
| `loot-cms` | File-based CMS, editor, sync storage | Research |
46+
| `loot-ops` | Org-wide Nix/IaC/CI platform glue for repos | Private |
47+
| `website` | Landing page, docs, bench measurements, stats | WIP |
48+
| `knowledge` | Obsidian KB, planning, issues, research | Internal |
849

9-
We welcome contributions! See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for guidelines.
50+
Public docs and public APIs are opening in phases as each track stabilizes.
1051

11-
## Security
52+
## 🗺️ 2026 Roadmap (WIP Checklist)
1253

13-
Found a vulnerability? See [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md) for responsible disclosure.
54+
### Milestone - Track Progress
55+
56+
- [x] 🧩 Evolu-based Bun-first baseline established
57+
- [x] 📦 Public track for `evolu-plan-b` prepared
58+
- [ ] 🧪 Benchmark harness foundation running in `bench-suite` (~45%)
59+
- [ ] 📈 Stable regression gates with p50/p95/throughput/memory evidence
60+
- [ ] 🏗️ SQLoot core bootstrap beyond skeleton phase
61+
- [ ] 🔐 Relay and transport hardening to public-ready operations
62+
- [ ] 🔌 Priority integrations (TanStack Start, Tauri, Astro) (~70%)
63+
- [ ] 🧩 Evolu compatibility and stabilization (~90%)
64+
- [ ] 📊 Benchmark reliability and CI evidence (~45%)
65+
- [ ] 🧱 SQLoot core bootstrap (~20%)
66+
- [ ] 🌐 Relay and transport hardening (~30%)
67+
- [ ] 🔌 Priority integrations (~20%)
68+
69+
## 🎯 Next 4 Weeks
70+
71+
1. Ship stable relay-sync benchmark lane with report schema v1.
72+
2. Deliver real finance reference workload for both demo and benchmark use.
73+
3. Finalize benchmark integration SDK/API for external app and framework lanes.
74+
4. Close bench reliability gaps (driver parity, scenario coverage, regression policy).
75+
5. Publish clearer public docs and benchmark evidence surfaces.
76+
77+
## 🤝 Contributing
78+
79+
Contributions are welcome. See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for workflow and quality standards.
80+
81+
## 🔐 Security
82+
83+
For responsible disclosure, see [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md).
1484

1585
---
1686

1787
<div align="center">
1888
<a href="https://github.com/enterprises/ownCTRL"><img src="https://img.shields.io/badge/©️_2026-ownCTRL™-333?style=flat&labelColor=ddd" alt="© 2026 ownCTRL™"/></a>
19-
<a href="https://github.com/ownctrl"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40ownctrl-333?style=flat&labelColor=ddd" alt="Maintained by @ownctrl"/></a>
89+
<a href="https://github.com/miccy"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40miccy-333?style=flat&labelColor=ddd" alt="Maintained by @miccy"/></a>
2090
</div>
91+

0 commit comments

Comments
 (0)