Skip to content

Commit c496931

Browse files
authored
docs: clean up spec compliance table on README.md (#252)
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>
1 parent 84f1ed9 commit c496931

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,16 +118,24 @@ There you will find Express.js, TypeScript and Websocket examples.
118118

119119
## Supported specification features
120120

121-
| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) |
121+
| Core Specification | [v0.3](v03spec) | [v1.0](v1spec) |
122122
| ----------------------------- | --- | --- |
123123
| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: |
124-
| AMQP Protocol Binding | :x: | :x: |
124+
---
125+
126+
| Event Formats | [v0.3](v03spec) | [v1.0](v1spec) |
127+
| ----------------------------- | --- | --- |
125128
| AVRO Event Format | :x: | :x: |
126-
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
127129
| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: |
130+
---
131+
132+
| Transport Protocols | [v0.3](v03spec) | [v1.0](v1spec) |
133+
| ----------------------------- | --- | --- |
134+
| AMQP Protocol Binding | :x: | :x: |
135+
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
128136
| Kafka Protocol Binding | :x: | :x: |
137+
| MQTT Protocol Binding | :x: | :x: |
129138
| NATS Protocol Binding | :x: | :x: |
130-
| STAN Protocol Binding | :x: | :x: |
131139

132140
## Community
133141

@@ -147,3 +155,6 @@ There you will find Express.js, TypeScript and Websocket examples.
147155
We love contributions from the community! Please check the
148156
[Contributor's Guide](https://github.com/cloudevents/sdk-javascript/blob/master/CONTRIBUTING.md)
149157
for information on how to get involved.
158+
159+
[v1spec]: https://github.com/cloudevents/spec/tree/v1.0
160+
[v103pec]: https://github.com/cloudevents/spec/tree/v0.3

0 commit comments

Comments
 (0)