From 0948ca31a67bd1c921647474fe3509e316d30eba Mon Sep 17 00:00:00 2001 From: Ryan Dunckel Date: Wed, 11 Aug 2021 10:36:38 -0500 Subject: [PATCH] organize the supported features section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Organizing for readability and a better "at a glance" understanding of the state of what this SDK supports. As a follow-up, I'd like to propose re-organizing the maven modules under "protocols" and "formats" modules, but I can address that in a different PR if you agree with that change, which would look something like this: ``` ├── api ├── benchmarks ├── bom ├── core ├── docs ├── examples │   ├── amqp-proton │   ├── basic-http │   ├── kafka │   ├── restful-ws-quarkus │   ├── restful-ws-spring-boot │   ├── spring-function │   ├── spring-reactive │   ├── spring-rsocket │   └── vertx ├── formats │   ├── avro │   ├── json-jackson │   └── protobuf ├── protocols | ├── amqp | ├── http | │   ├── basic | │   ├── restful-ws | │   ├── restful-ws-integration-tests | │   └── vertx | ├── kafka ├── spring └── sql ``` --- README.md | 47 +++++++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e5e86ba13..59a3b0fc0 100644 --- a/README.md +++ b/README.md @@ -32,26 +32,33 @@ Stay tuned! Supported features of the specification: -| | [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: | -| - [Proton](amqp) | :heavy_check_mark: | :heavy_check_mark: | -| AVRO Event Format | :x: | :x: | -| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: | -| - [Vert.x](http/vertx) | :heavy_check_mark: | :heavy_check_mark: | -| - [Jakarta Restful WS](http/restful-ws) | :heavy_check_mark: | :heavy_check_mark: | -| - [Basic](http/basic) | :heavy_check_mark: | :heavy_check_mark: | -| - [Spring](spring) | :heavy_check_mark: | :heavy_check_mark: | -| - [http4k][http4k]†| :heavy_check_mark: | :heavy_check_mark: | -| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: | -| - [Jackson](formats/json-jackson) | :heavy_check_mark: | :heavy_check_mark: | -| Protobuf Event Format | :heavy_check_mark: | :heavy_check_mark: | -| - [Proto](formats/protobuf) | :heavy_check_mark: | :heavy_check_mark: | -| [Kafka Protocol Binding](kafka) | :heavy_check_mark: | :heavy_check_mark: | -| MQTT Protocol Binding | :x: | :x: | -| NATS Protocol Binding | :x: | :x: | -| Web hook | :x: | :x: | +| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) | +| :---------------------------------------- | :---------------------------------------------------: | :---------------------------------------------------: | +| Core | :heavy_check_mark: | :heavy_check_mark: | +| | | | +| **Protocol Bindings** | | | +| AMQP | :x: | :x: | +| - _[Proton](amqp)_ | :heavy_check_mark: | :heavy_check_mark: | +| HTTP | :heavy_check_mark: | :heavy_check_mark: | +| - _[Vert.x](http/vertx)_ | :heavy_check_mark: | :heavy_check_mark: | +| - _[Jakarta Restful WS](http/restful-ws)_ | :heavy_check_mark: | :heavy_check_mark: | +| - _[Basic](http/basic)_ | :heavy_check_mark: | :heavy_check_mark: | +| - _[Spring](spring)_ | :heavy_check_mark: | :heavy_check_mark: | +| - _[http4k][http4k]†_ | :heavy_check_mark: | :heavy_check_mark: | +| [Kafka](kafka) | :heavy_check_mark: | :heavy_check_mark: | +| MQTT | :x: | :x: | +| NATS | :x: | :x: | +| WebSockets | :x: | :x: | +| | | | +| **Event Formats** | | | +| AVRO | :x: | :x: | +| JSON | :heavy_check_mark: | :heavy_check_mark: | +| - _[Jackson](formats/json-jackson)_ | :heavy_check_mark: | :heavy_check_mark: | +| Protobuf | :heavy_check_mark: | :heavy_check_mark: | +| - _[Proto](formats/protobuf)_ | :heavy_check_mark: | :heavy_check_mark: | +| | | | +| Web hook | :x: | :x: | + † Source/artifacts hosted externally