Skip to content

Commit e4d3370

Browse files
authored
Update README to reflect new structure (#137)
Signed-off-by: Jim Crossley <[email protected]>
1 parent 432259b commit e4d3370

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,29 @@ Note: This project is WIP under active development, hence all APIs are considere
1818
| NATS Protocol Binding |||
1919
| Web hook |||
2020

21-
## Crates
21+
## Crate Structure
2222

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.
2835

2936
## Get Started
3037

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:
3240

3341
```toml
3442
[dependencies]
35-
cloudevents-sdk = "0.3.1"
43+
cloudevents-sdk = { version = "0.3.1", features = ["cloudevents-actix"] }
3644
```
3745

3846
Now you can start creating events:
@@ -89,3 +97,4 @@ information.
8997
[crates.io]: https://crates.io/crates/cloudevents-sdk
9098
[Docs badge]: https://docs.rs/cloudevents-sdk/badge.svg
9199
[docs.rs]: https://docs.rs/cloudevents-sdk
100+
[feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section

0 commit comments

Comments
 (0)