Skip to content

Commit f294cec

Browse files
Fixed all readmes (cloudevents#51)
Signed-off-by: Francesco Guardiani <[email protected]>
1 parent b832b6b commit f294cec

File tree

5 files changed

+68
-10
lines changed

5 files changed

+68
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
This project implements the [CloudEvents](https://cloudevents.io/) Spec for Rust.
44

5-
Note: This projecets is WIP under active development, hence all APIs are considered unstable.
5+
Note: This project is WIP under active development, hence all APIs are considered unstable.
66

77
## Spec support
88

99
| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) |
1010
| :---------------------------: | :----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: |
11-
| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: |
12-
| AMQP Protocol Binding | :x: | :x: |
13-
| AVRO Event Format | :x: | :x: |
14-
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
15-
| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: |
16-
| Kafka Protocol Binding | :x: | :x: |
17-
| MQTT Protocol Binding | :x: | :x: |
18-
| NATS Protocol Binding | :x: | :x: |
19-
| Web hook | :x: | :x: |
11+
| CloudEvents Core | | |
12+
| AMQP Protocol Binding | | |
13+
| AVRO Event Format | | |
14+
| HTTP Protocol Binding | | |
15+
| JSON Event Format | | |
16+
| Kafka Protocol Binding | | |
17+
| MQTT Protocol Binding | | |
18+
| NATS Protocol Binding | | |
19+
| Web hook | | |
2020

2121
## Crates
2222

cloudevents-sdk-actix-web/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ edition = "2018"
77
description = "CloudEvents official Rust SDK - Actix-Web integration"
88
documentation = "https://docs.rs/cloudevents-sdk-actix-web"
99
repository = "https://github.com/cloudevents/sdk-rust"
10+
readme = "README.md"
1011

1112
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1213

cloudevents-sdk-actix-web/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CloudEvents SDK Rust - Actix-Web [![Crates badge]][crates.io] [![Docs badge]][docs.rs]
2+
3+
Integration of [CloudEvents SDK](https://github.com/cloudevents/sdk-rust/) with [Actix Web](https://github.com/actix/actix-web).
4+
5+
Look at [CloudEvents SDK README](https://github.com/cloudevents/sdk-rust/) for more info.
6+
7+
## Development & Contributing
8+
9+
If you're interested in contributing to sdk-rust, look at [Contributing documentation](../CONTRIBUTING.md)
10+
11+
## Community
12+
13+
- There are bi-weekly calls immediately following the
14+
[Serverless/CloudEvents call](https://github.com/cloudevents/spec#meeting-time)
15+
at 9am PT (US Pacific). Which means they will typically start at 10am PT, but
16+
if the other call ends early then the SDK call will start early as well. See
17+
the
18+
[CloudEvents meeting minutes](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#)
19+
to determine which week will have the call.
20+
- Slack: #cloudeventssdk (or #cloudevents-sdk-rust) channel under
21+
[CNCF's Slack workspace](https://slack.cncf.io/).
22+
- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
23+
- Contact for additional information: Francesco Guardiani (`@slinkydeveloper` on slack).
24+
25+
[Crates badge]: https://img.shields.io/crates/v/cloudevents-sdk-actix-web.svg
26+
[crates.io]: https://crates.io/crates/cloudevents-sdk-actix-web
27+
[Docs badge]: https://docs.rs/cloudevents-sdk-actix-web/badge.svg
28+
[docs.rs]: https://docs.rs/cloudevents-sdk-actix-web

cloudevents-sdk-reqwest/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ edition = "2018"
77
description = "CloudEvents official Rust SDK - Reqwest integration"
88
documentation = "https://docs.rs/cloudevents-sdk-reqwest"
99
repository = "https://github.com/cloudevents/sdk-rust"
10+
readme = "README.md"
1011

1112
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1213

cloudevents-sdk-reqwest/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CloudEvents SDK Rust - Reqwest [![Crates badge]][crates.io] [![Docs badge]][docs.rs]
2+
3+
Integration of [CloudEvents SDK](https://github.com/cloudevents/sdk-rust/) with [reqwest](https://github.com/seanmonstar/reqwest)
4+
5+
Look at [CloudEvents SDK README](https://github.com/cloudevents/sdk-rust/) for more info.
6+
7+
## Development & Contributing
8+
9+
If you're interested in contributing to sdk-rust, look at [Contributing documentation](../CONTRIBUTING.md)
10+
11+
## Community
12+
13+
- There are bi-weekly calls immediately following the
14+
[Serverless/CloudEvents call](https://github.com/cloudevents/spec#meeting-time)
15+
at 9am PT (US Pacific). Which means they will typically start at 10am PT, but
16+
if the other call ends early then the SDK call will start early as well. See
17+
the
18+
[CloudEvents meeting minutes](https://docs.google.com/document/d/1OVF68rpuPK5shIHILK9JOqlZBbfe91RNzQ7u_P7YCDE/edit#)
19+
to determine which week will have the call.
20+
- Slack: #cloudeventssdk (or #cloudevents-sdk-rust) channel under
21+
[CNCF's Slack workspace](https://slack.cncf.io/).
22+
- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
23+
- Contact for additional information: Francesco Guardiani (`@slinkydeveloper` on slack).
24+
25+
[Crates badge]: https://img.shields.io/crates/v/cloudevents-sdk-reqwest.svg
26+
[crates.io]: https://crates.io/crates/cloudevents-sdk-reqwest
27+
[Docs badge]: https://docs.rs/cloudevents-sdk-reqwest/badge.svg
28+
[docs.rs]: https://docs.rs/cloudevents-sdk-reqwest

0 commit comments

Comments
 (0)