diff --git a/Cargo.lock b/Cargo.lock index 1e1b4bf..105cf7d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -28,7 +28,7 @@ dependencies = [ [[package]] name = "allegedly" -version = "0.1.0" +version = "0.2.0" dependencies = [ "anyhow", "async-compression", diff --git a/Cargo.toml b/Cargo.toml index fa61f33..6d558c0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "allegedly" description = "public ledger server tools and services (for the PLC)" license = "MIT OR Apache-2.0" -version = "0.1.0" +version = "0.2.0" edition = "2024" default-run = "allegedly" diff --git a/readme.md b/readme.md index 6ba1189..b1e8406 100644 --- a/readme.md +++ b/readme.md @@ -53,6 +53,34 @@ to install the latest from source: ``` +## future improvements + +### existing stuff + +- signals and shutdown handling +- monitoring of the various tasks +- health check pings +- expose metrics/tracing +- read-only flag for mirror wrapper +- bundle: write directly to s3-compatible object storage +- helpers for automating periodic `bundle` runs + + +### new things + +- experimental: websocket version of /export +- experimental: accept writes by forwarding them upstream +- experimental: serve a tlog +- experimental: embed a log database directly for fast and efficient mirroring +- experimental: support multiple upstreams? + +- [ ] new command todo: `zip` or `check` or `diff`: compare two plc logs over some time range +- [ ] new command to consider: `scatter` or something: broadcast plc writes to multiple upstreams + + +if you have an idea for a new command, [open a request](https://tangled.org/@microcosm.blue/Allegedly/issues/new)! + + ## license This work is dual-licensed under MIT and Apache 2.0. You can choose between one of them if you use this work.