You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-8Lines changed: 17 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,21 +18,29 @@ Note: This project is WIP under active development, hence all APIs are considere
18
18
| NATS Protocol Binding | ✕ | ✕ |
19
19
| Web hook | ✕ | ✕ |
20
20
21
-
## Crates
21
+
## Crate Structure
22
22
23
-
*`cloudevents-sdk`: Provides Event data structure, JSON Event format implementation. This module is tested to work with GNU libc, WASM and musl toolchains.
24
-
*`cloudevents-sdk-actix-web`: Integration with [Actix Web](https://github.com/actix/actix-web).
25
-
*`cloudevents-sdk-reqwest`: Integration with [reqwest](https://github.com/seanmonstar/reqwest).
26
-
*`cloudevents-sdk-rdkafka`: Integration with [rust-rdkafka](https://fede1024.github.io/rust-rdkafka).
27
-
*`cloudevents-sdk-warp`: Integration with [warp](https://github.com/seanmonstar/warp/).
23
+
The core modules include definitions for the `Event` and
24
+
`EventBuilder` data structures, JSON serialization rules, and a
25
+
mechanism to support various Protocol Bindings, each of which is
26
+
enabled by a specific [feature flag]:
27
+
28
+
*`cloudevents-actix`: Integration with [actix](https://actix.rs/).
29
+
*`cloudevents-warp`: Integration with [warp](https://github.com/seanmonstar/warp/).
30
+
*`cloudevents-reqwest`: Integration with [reqwest](https://github.com/seanmonstar/reqwest).
31
+
*`cloudevents-rdkafka`: Integration with [rdkafka](https://fede1024.github.io/rust-rdkafka).
32
+
33
+
This crate is continuously tested to work with GNU libc, WASM and musl
34
+
toolchains.
28
35
29
36
## Get Started
30
37
31
-
To get started, add the dependency to `Cargo.toml`:
38
+
To get started, add the dependency to `Cargo.toml`, optionally
39
+
enabling your Protocol Binding of choice:
32
40
33
41
```toml
34
42
[dependencies]
35
-
cloudevents-sdk = "0.3.1"
43
+
cloudevents-sdk = { version = "0.3.1", features = ["cloudevents-actix"] }
0 commit comments