diff --git a/README.md b/README.md index 34bedec..b51762c 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,17 @@ Usage - Run tests via ./test.sh (pytest-based tests included) This README intentionally keeps surface area small while documenting how to extend for a production-grade setup. + +## Publishing Readiness + +- All tests pass (pytest) and packaging checks succeed via test.sh, which also validates Python packaging metadata. +- This MVP includes core components: CatOpt bridge, Energi bridge, GoC bridge, a minimal DSL sketch, contract registry, and reference adapters. +- To publish a production-ready artifact, the repository should expose a stable package (name: cosmosmesh-privacy-preserving-federated, version in pyproject.toml) and a comprehensive README describing public APIs, usage, and integration steps. +- Next step for publishing: create an empty READY_TO_PUBLISH flag file at the repo root to signal readiness once all requirements are satisfied. + +## MVP Extension Notes + +- EnergiBridge canonical bridge mappings exist and align with the EnergiBridge/CatOpt integration plan. +- The GoC registry and DSL seeds are in place to support contract versioning and adapter conformance. +- Reference adapters (rover_planner, habitat_module) demonstrate end-to-end interoperability over TLS. +- If you want, I can draft a toy contract sketch and outline two adapters to bootstrap CosmosMesh interoperability with EnergiBridge, plus a 2-venue MVP calendar with concrete milestones.