diff --git a/README.md b/README.md index c3de360..0d2568a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,46 @@ -# .github -Special GitHub repo for organization health files ✨ +# SQLoot `.github` + +Public organization-health repository for SQLoot. + +## Purpose + +This repository defines public defaults used across SQLoot repositories: + +- community policy files (`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, `SUPPORT.md`) +- issue and pull request templates +- workflow templates for new repositories +- organization profile content (`profile/README.md`) +- shared ownership baseline (`CODEOWNERS`) + +## Repository structure + +```text +. +├── .github/ +│ └── dependabot.yml +├── ISSUE_TEMPLATE/ +├── workflow-templates/ +├── profile/ +│ └── README.md +├── CODEOWNERS +├── CODE_OF_CONDUCT.md +├── CONTRIBUTING.md +├── FUNDING.yml +├── PULL_REQUEST_TEMPLATE.md +├── SECURITY.md +└── SUPPORT.md +``` + +## Operating rules + +- Keep everything public-safe (no internal links, no private roadmap details, no operational secrets). +- Treat changes as org-wide defaults; update with explicit, reviewable edits. +- Keep templates aligned with active delivery priorities in public repos. + +## Related repositories + +- Public profile: [`profile/README.md`](./profile/README.md) +- Internal-only counterpart: `SQLoot/.github-private` --- diff --git a/profile/README.md b/profile/README.md index 2f6342c..70fe0c0 100644 --- a/profile/README.md +++ b/profile/README.md @@ -3,83 +3,59 @@

- Local-First | Lab | E2EE | Infra | Benchmarks | Tools | CLI | Adapters | CRDT Sync | Relays
- Public rollout is in progress (updated March 1, 2026). + Local-First Runtime, Tooling, Relay Infrastructure, and Evidence-Driven Benchmarks.
+ Public rollout is in progress.

Public rollout WIP Foundation Evolu - SQLite compatibility - Bun-first runtime + Bun-first | v1.3.10

-## ⚡ Why SQLoot +## Why SQLoot -- 🌍 Grow the local-first community and make the ecosystem easier to discover and adopt. -- 🛠️ Build practical tools and a robust CLI for developers and operators. -- ⚡ Push performance in critical paths with Zig/Rust and systems-level optimizations. -- 🧩 Keep Evolu compatibility while delivering upgrades and upstream-ready improvements. -- 🧪 Run experiments, publish benchmarks, and propose new local-first specs where needed. -- 🤖 Advance local-first collaboration patterns for AI agents. +SQLoot builds local-first infrastructure and products that preserve user data ownership while staying practical for real deployments. -## 🤝 Foundation: Evolu +Current strategy: -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. +- keep compatibility with Evolu upstream where it matters +- ship measurable improvements in SQLoot-owned tracks +- expose benchmark evidence and operational runbooks publicly -- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu) -- Upstream docs: [evolu.dev](https://www.evolu.dev) -- SQLoot baseline fork: [SQLoot/evolu-plan-b](https://github.com/SQLoot/evolu-plan-b) - -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. - -## 🧱 What SQLoot Is Building +## Repository Links -| Track | Role | Current State | -|---|---|---| -| `evolu-plan-b` | Evolu-compatible Bun + Biome baseline | Public rollout | -| `core` | SQLoot-native runtime foundations (Rust/Zig) | Planning | -| `bench-suite` | Reproducible benchmark harness | WIP | -| `relays` | Evolu-compatible relay implementations (Bun+Elysia/Rust/BEAM) | WIP | -| `lootbox` | CLI umbrella, TUI, tools (Rust) | WIP | -| `blind-cloud` | Encrypted cloud transport experiments (vault/relay/repacker) | Research | -| `local-first` | Community forum, blog, wiki, guides | TBD | -| `loot-cms` | File-based CMS, editor, sync storage | Research | -| `loot-ops` | Org-wide platform glue for repos (Nix/IaC/CI) | Private | -| `website` | Landing page, docs, bench measurements, stats | WIP | -| `knowledge` | Obsidian KB, planning, issues, research | Internal | +| Repository | Link status | Purpose | Current focus | +| --- | --- | --- | --- | +| [`evolu-plan-b`](https://github.com/SQLoot/evolu-plan-b) | Available | Evolu-compatible Bun + Biome baseline | Integrations hardening, `Electrobun` bootstrap (P0) | +| `bench-suite` | Link removed (not publicly available) | Reproducible benchmark harness | Regression gates, comparable matrix outputs | +| `relays` | Link removed (not publicly available) | Evolu-compatible relay implementations | Compatibility + hardening lanes | +| `website` | Link removed (not publicly available) | Public docs and product web surfaces | Docs + benchmark visibility | +| `SQLoot.github.io` | Link removed (not publicly available) | Deployment target for public pages | Stable publishing surface | +| `awesome-local-first` | Link removed (not publicly available) | Curated local-first ecosystem list | Curation baseline and taxonomy | -Public docs and public APIs are opening in phases as each track stabilizes. +## 2026 Delivery Priorities -## 🗺️ 2026 Roadmap (WIP) +1. `Electrobun` integration in `evolu-plan-b` as top execution priority. +2. Integration reliability lanes (TanStack Start, Astro, Tauri). +3. Benchmark evidence quality (`p50/p95/throughput/memory`) with reproducible CI output. +4. Relay compatibility hardening with explicit failure-mode testing. +5. Public docs quality and operational guidance for adopters. -### Milestone Progress (as of March 1, 2026) +## Foundation: Evolu -- [x] 📦 Public track for `evolu-plan-b` prepared (100%) -- [x] 🧩 Evolu-based Bun-first baseline established (95%) -- [ ] 🔌 Priority integrations (TanStack Start, Tauri, Astro) (75%) -- [ ] 🧪 Benchmark harness foundation in `bench-suite` (45%) -- [ ] 📊 Regression evidence gates (p50/p95/throughput/memory) (40%) -- [ ] 🌐 Relay and transport hardening (`relays`, `blind-cloud`) (30%) -- [ ] 🧱 SQLoot core bootstrap (`core`) (20%) -- [ ] 🛠️ `lootbox` CLI baseline (scope, commands, packaging) (25%) -- [ ] 📚 Public docs and evidence surfaces (`website`, `local-first`) (35%) - -## 🎯 Next 4 Weeks +- Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu) +- Upstream docs: [evolu.dev](https://www.evolu.dev) -1. Lock `evolu-plan-b` public baseline: keep CI green, tighten docs, and close rollout gaps. -2. Ship `bench-suite` baseline lanes with reproducible report schema and first regression thresholds. -3. Stabilize integration lanes for TanStack Start, Tauri, and Astro with actionable smoke outputs. -4. Define and run relay hardening matrix for reconnect/load/failure handling in `relays`. -5. Ship `lootbox` CLI v0 scope and first operator commands for workspace/bootstrap + benchmark flows. +Credit to [evoluhq](https://github.com/evoluhq) and [@steida](https://github.com/steida) for creating Evolu and pushing the local-first ecosystem forward. -## 🤝 Contributing +## Contributing -Contributions are welcome. See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for workflow and quality standards. +See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md). -## 🔐 Security +## Security -For responsible disclosure, see [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md). +See [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md). ---