Skip to content

Commit

Permalink
docs: clean up spec compliance table on README.md (#252)
Browse files Browse the repository at this point in the history
This commit separates the spec compliance table in the README.md file
into three: the core spec, event formats, and transport protocols.

Fixes: #166
Signed-off-by: Lance Ball <lball@redhat.com>
  • Loading branch information
lance authored Jul 16, 2020
1 parent 84f1ed9 commit c496931
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,24 @@ There you will find Express.js, TypeScript and Websocket examples.

## Supported specification features

| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) |
| Core Specification | [v0.3](v03spec) | [v1.0](v1spec) |
| ----------------------------- | --- | --- |
| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: |
| AMQP Protocol Binding | :x: | :x: |
---

| Event Formats | [v0.3](v03spec) | [v1.0](v1spec) |
| ----------------------------- | --- | --- |
| AVRO Event Format | :x: | :x: |
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: |
---

| Transport Protocols | [v0.3](v03spec) | [v1.0](v1spec) |
| ----------------------------- | --- | --- |
| AMQP Protocol Binding | :x: | :x: |
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
| Kafka Protocol Binding | :x: | :x: |
| MQTT Protocol Binding | :x: | :x: |
| NATS Protocol Binding | :x: | :x: |
| STAN Protocol Binding | :x: | :x: |

## Community

Expand All @@ -147,3 +155,6 @@ There you will find Express.js, TypeScript and Websocket examples.
We love contributions from the community! Please check the
[Contributor's Guide](https://github.com/cloudevents/sdk-javascript/blob/master/CONTRIBUTING.md)
for information on how to get involved.

[v1spec]: https://github.com/cloudevents/spec/tree/v1.0
[v103pec]: https://github.com/cloudevents/spec/tree/v0.3

0 comments on commit c496931

Please sign in to comment.