Skip to content

Commit c2ce184

Browse files
committed
docs: update README to include roadmap, current status, and clarify demo simulation
1 parent ab55beb commit c2ce184

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,18 @@
22
<img src="assets/logo.png" alt="AimDB Logo" width="300">
33
</div>
44

5-
[![Build Status](https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/ci.yml?branch=main)](https://github.com/aimdb-dev/aimdb/actions)
5+
[!## 🛣 Roadmap & Help Wanted
6+
**Current Status**: Early development - foundational architecture is being implemented.
7+
8+
Core priorities where you can make a huge impact:
9+
- 🚧 **Core Database Engine** – implement in-memory storage with async operations
10+
- 🚧 **MCU Runtime** – tighten Embassy executor integration and notification system
11+
- 🧪 **Connectors** – expand MQTT/Kafka/DDS bridges, add gRPC/WebSocket bridges
12+
- 📊 **Observability** – lightweight metrics and health probes
13+
- 📚 **Docs & Examples** – more templates, edge-to-cloud demos
14+
- 🔐 **Access Control Hooks** – refine built-in identity & metering
15+
16+
Check the Issues board for "help wanted" labels or propose your own ideas.atus](https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/ci.yml?branch=main)](https://github.com/aimdb-dev/aimdb/actions)
617
[![Security Audit](https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/security.yml?branch=main&label=security)](https://github.com/aimdb-dev/aimdb/actions)
718
[![Documentation](https://img.shields.io/github/actions/workflow/status/aimdb-dev/aimdb/docs.yml?branch=main&label=docs)](https://github.com/aimdb-dev/aimdb/actions)
819
[![Crates.io](https://img.shields.io/crates/v/aimdb.svg)](https://crates.io/crates/aimdb)
@@ -11,6 +22,9 @@
1122
[![Docs](https://docs.rs/aimdb/badge.svg)](https://docs.rs/aimdb)
1223
[![Website](https://img.shields.io/badge/website-aimdb.dev-blue.svg)](https://aimdb.dev)
1324

25+
> **⚠️ EARLY DEVELOPMENT STAGE**
26+
> AimDB is currently in **very early development**. The architecture is defined and the foundation is being built, but most features are not yet implemented. This is a work-in-progress project where core functionality is still being developed. Expect breaking changes and incomplete features.
27+
1428
> **One codebase. Any hardware. Always in sync.**
1529
1630
AimDB is an **async, in-memory database** that keeps state and streams **consistent across MCU → edge → cloud** — without internal brokers, glue code or vendor lock-in. If you’ve ever juggled MQTT bridges, SQLite caches and custom sync scripts just to move live data, AimDB is here to simplify your world.
@@ -54,16 +68,16 @@ code .
5468

5569
# 3. Inside the container, everything is ready:
5670
cargo build --release
57-
cargo run --example quickstart
71+
cargo run --example quickstart -p aimdb-examples
5872
```
5973

6074
**✅ Zero Setup**: Rust, embedded targets and development tools pre-installed
6175
**✅ Cross-Platform**: Works on macOS, Linux, Windows (with Docker Desktop) or WSL
6276
**✅ VS Code Ready**: Optimized extensions and settings included
6377

64-
You should see events syncing between simulated devices and a local edge gateway!
78+
You should see a demo simulation showing the concept of data syncing between devices, edge, and cloud!
6579

66-
> **💡 Tip**: The devcontainer includes all embedded targets and tools like `cargo-audit`, `cargo-watch` and debugging support for MCU development.
80+
> **💡 Note**: The current demo is a simple simulation. Real AimDB functionality is still being implemented as part of the early development process.
6781
6882
---
6983

0 commit comments

Comments
 (0)