diff --git a/README.md b/README.md index 446cdfc..d9613a9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # eventsourcingdb-client-rust -The official Rust client SDK for EventSourcingDB. + +The official Rust client SDK for [EventSourcingDB](https://www.eventsourcingdb.io/). + +# Project status + +This is a work in progress and not yet ready for production use. +Based on the [compliance criteria](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/) the SDK covers these criteria: + +- ❌ [Essentials](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#essentials) +- ❌ [Writing Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#writing-events) +- ❌ [Reading Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#reading-events) +- ❌ [Using EventQL](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#using-eventql) +- ❌ [Observing Events](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#observing-events) +- ❌ [Metadata and Discovery](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#metadata-and-discovery) +- ❌ [Testcontainers Support](https://docs.eventsourcingdb.io/client-sdks/compliance-criteria/#testcontainers-support) diff --git a/src/lib.rs b/src/lib.rs index b93cf3f..5337c09 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,14 +1,16 @@ -pub fn add(left: u64, right: u64) -> u64 { - left + right -} +#![doc = include_str!("../README.md")] -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn it_works() { - let result = add(2, 2); - assert_eq!(result, 4); - } -} +#![deny( + ambiguous_negative_literals, + clippy::pedantic, + missing_debug_implementations, + missing_docs, + trivial_casts, + trivial_numeric_casts, + unused_extern_crates, + unused_import_braces, + unused_qualifications, + unused_results, + unsafe_code, + warnings +)]