From f294cec0febf117408d193b2697aad3704cd8d26 Mon Sep 17 00:00:00 2001 From: Francesco Guardiani Date: Fri, 29 May 2020 14:04:44 +0200 Subject: [PATCH] Fixed all readmes (#51) Signed-off-by: Francesco Guardiani --- README.md | 20 ++++++++++---------- cloudevents-sdk-actix-web/Cargo.toml | 1 + cloudevents-sdk-actix-web/README.md | 28 ++++++++++++++++++++++++++++ cloudevents-sdk-reqwest/Cargo.toml | 1 + cloudevents-sdk-reqwest/README.md | 28 ++++++++++++++++++++++++++++ 5 files changed, 68 insertions(+), 10 deletions(-) create mode 100644 cloudevents-sdk-actix-web/README.md create mode 100644 cloudevents-sdk-reqwest/README.md diff --git a/README.md b/README.md index 413a7b7..4c4fde1 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,21 @@ This project implements the [CloudEvents](https://cloudevents.io/) Spec for Rust. -Note: This projecets is WIP under active development, hence all APIs are considered unstable. +Note: This project is WIP under active development, hence all APIs are considered unstable. ## Spec support | | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) | | :---------------------------: | :----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: | -| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: | -| AMQP Protocol Binding | :x: | :x: | -| AVRO Event Format | :x: | :x: | -| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: | -| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: | -| Kafka Protocol Binding | :x: | :x: | -| MQTT Protocol Binding | :x: | :x: | -| NATS Protocol Binding | :x: | :x: | -| Web hook | :x: | :x: | +| CloudEvents Core | ✓ | ✓ | +| AMQP Protocol Binding | ✕ | ✕ | +| AVRO Event Format | ✕ | ✕ | +| HTTP Protocol Binding | ✓ | ✓ | +| JSON Event Format | ✓ | ✓ | +| Kafka Protocol Binding | ✕ | ✕ | +| MQTT Protocol Binding | ✕ | ✕ | +| NATS Protocol Binding | ✕ | ✕ | +| Web hook | ✕ | ✕ | ## Crates diff --git a/cloudevents-sdk-actix-web/Cargo.toml b/cloudevents-sdk-actix-web/Cargo.toml index f87e0c8..f0222cb 100644 --- a/cloudevents-sdk-actix-web/Cargo.toml +++ b/cloudevents-sdk-actix-web/Cargo.toml @@ -7,6 +7,7 @@ edition = "2018" description = "CloudEvents official Rust SDK - Actix-Web integration" documentation = "https://docs.rs/cloudevents-sdk-actix-web" repository = "https://github.com/cloudevents/sdk-rust" +readme = "README.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/cloudevents-sdk-actix-web/README.md b/cloudevents-sdk-actix-web/README.md new file mode 100644 index 0000000..b3c2d38 --- /dev/null +++ b/cloudevents-sdk-actix-web/README.md @@ -0,0 +1,28 @@ +# CloudEvents SDK Rust - Actix-Web [![Crates badge]][crates.io] [![Docs badge]][docs.rs] + +Integration of [CloudEvents SDK](https://github.com/cloudevents/sdk-rust/) with [Actix Web](https://github.com/actix/actix-web). + +Look at [CloudEvents SDK README](https://github.com/cloudevents/sdk-rust/) for more info. + +## Development & Contributing + +If you're interested in contributing to sdk-rust, look at [Contributing documentation](../CONTRIBUTING.md) + +## Community + +- There are bi-weekly calls immediately following the + [Serverless/CloudEvents call](https://github.com/cloudevents/spec#meeting-time) + at 9am PT (US Pacific). Which means they will typically start at 10am PT, but + if the other call ends early then the SDK call will start early as well. See + the + [CloudEvents meeting minutes](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#) + to determine which week will have the call. +- Slack: #cloudeventssdk (or #cloudevents-sdk-rust) channel under + [CNCF's Slack workspace](https://slack.cncf.io/). +- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk +- Contact for additional information: Francesco Guardiani (`@slinkydeveloper` on slack). + +[Crates badge]: https://img.shields.io/crates/v/cloudevents-sdk-actix-web.svg +[crates.io]: https://crates.io/crates/cloudevents-sdk-actix-web +[Docs badge]: https://docs.rs/cloudevents-sdk-actix-web/badge.svg +[docs.rs]: https://docs.rs/cloudevents-sdk-actix-web \ No newline at end of file diff --git a/cloudevents-sdk-reqwest/Cargo.toml b/cloudevents-sdk-reqwest/Cargo.toml index db3fde8..5683d21 100644 --- a/cloudevents-sdk-reqwest/Cargo.toml +++ b/cloudevents-sdk-reqwest/Cargo.toml @@ -7,6 +7,7 @@ edition = "2018" description = "CloudEvents official Rust SDK - Reqwest integration" documentation = "https://docs.rs/cloudevents-sdk-reqwest" repository = "https://github.com/cloudevents/sdk-rust" +readme = "README.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/cloudevents-sdk-reqwest/README.md b/cloudevents-sdk-reqwest/README.md new file mode 100644 index 0000000..920c65f --- /dev/null +++ b/cloudevents-sdk-reqwest/README.md @@ -0,0 +1,28 @@ +# CloudEvents SDK Rust - Reqwest [![Crates badge]][crates.io] [![Docs badge]][docs.rs] + +Integration of [CloudEvents SDK](https://github.com/cloudevents/sdk-rust/) with [reqwest](https://github.com/seanmonstar/reqwest) + +Look at [CloudEvents SDK README](https://github.com/cloudevents/sdk-rust/) for more info. + +## Development & Contributing + +If you're interested in contributing to sdk-rust, look at [Contributing documentation](../CONTRIBUTING.md) + +## Community + +- There are bi-weekly calls immediately following the + [Serverless/CloudEvents call](https://github.com/cloudevents/spec#meeting-time) + at 9am PT (US Pacific). Which means they will typically start at 10am PT, but + if the other call ends early then the SDK call will start early as well. See + the + [CloudEvents meeting minutes](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#) + to determine which week will have the call. +- Slack: #cloudeventssdk (or #cloudevents-sdk-rust) channel under + [CNCF's Slack workspace](https://slack.cncf.io/). +- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk +- Contact for additional information: Francesco Guardiani (`@slinkydeveloper` on slack). + +[Crates badge]: https://img.shields.io/crates/v/cloudevents-sdk-reqwest.svg +[crates.io]: https://crates.io/crates/cloudevents-sdk-reqwest +[Docs badge]: https://docs.rs/cloudevents-sdk-reqwest/badge.svg +[docs.rs]: https://docs.rs/cloudevents-sdk-reqwest \ No newline at end of file