Docs (#135)
* Added jemoji Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Renamed vertx module to cloudevents-http-vertx Fixed docs Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
This commit is contained in:
parent
1b03ee1a93
commit
bf3514459b
|
@ -1 +1,3 @@
|
||||||
theme: jekyll-theme-slate
|
theme: jekyll-theme-slate
|
||||||
|
plugins:
|
||||||
|
- jemoji
|
||||||
|
|
|
@ -2,7 +2,12 @@
|
||||||
|
|
||||||
A Java API for the [CloudEvents specification](https://github.com/cloudevents/spec)
|
A Java API for the [CloudEvents specification](https://github.com/cloudevents/spec)
|
||||||
|
|
||||||
## Supported specification features
|
1. [Supported Specification Features](#supported-specification-features)
|
||||||
|
1. [Modules](#modules)
|
||||||
|
1. [Get Started](#get-started)
|
||||||
|
1. [Use an event format](#use-an-event-format)
|
||||||
|
|
||||||
|
## Supported Specification Features
|
||||||
|
|
||||||
Supported features of the specification:
|
Supported features of the specification:
|
||||||
|
|
||||||
|
@ -12,10 +17,31 @@ Supported features of the specification:
|
||||||
| AMQP Protocol Binding | :x: | :x: |
|
| AMQP Protocol Binding | :x: | :x: |
|
||||||
| AVRO Event Format | :x: | :x: |
|
| AVRO Event Format | :x: | :x: |
|
||||||
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
|
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
|
||||||
| - [Vert.x](http/vertx) | :heavy_check_mark: | :heavy_check_mark: |
|
| - [Vert.x](https://github.com/cloudevents/sdk-java/tree/master/http/vertx) | :heavy_check_mark: | :heavy_check_mark: |
|
||||||
| JSON Event Format | :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: |
|
| - [Jackson](https://github.com/cloudevents/sdk-java/tree/master/formats/json-jackson) | :heavy_check_mark: | :heavy_check_mark: |
|
||||||
| Kafka Protocol Binding | :x: | :x: |
|
| Kafka Protocol Binding | :x: | :x: |
|
||||||
| MQTT Protocol Binding | :x: | :x: |
|
| MQTT Protocol Binding | :x: | :x: |
|
||||||
| NATS Protocol Binding | :x: | :x: |
|
| NATS Protocol Binding | :x: | :x: |
|
||||||
| Web hook | :x: | :x: |
|
| Web hook | :x: | :x: |
|
||||||
|
|
||||||
|
## Modules
|
||||||
|
|
||||||
|
The CloudEvents SDK for Java is composed by several modules, each one providing a different feature from the different subspecs of [CloudEvents specification](#supported-specification-features):
|
||||||
|
|
||||||
|
* [`cloudevents-api`](https://github.com/cloudevents/sdk-java/tree/master/api): Base module providing
|
||||||
|
* `CloudEvent` class, the in memory representation of a CloudEvent
|
||||||
|
* `CloudEventBuilder`, the builder to create `CloudEvent`s programmatically
|
||||||
|
* `EventFormat`, the abstraction to implement [Event Formats](https://github.com/cloudevents/spec/blob/v1.0/spec.md#event-format)
|
||||||
|
* `Message`/`MessageVisitor`, the abstractions to implement [Protocol bindings](https://github.com/cloudevents/spec/blob/v1.0/spec.md#protocol-binding)
|
||||||
|
* [`cloudevents-json-jackson`](https://github.com/cloudevents/sdk-java/tree/master/formats/json-jackson): Implementation of [JSON Event format] with [Jackson](https://github.com/FasterXML/jackson)
|
||||||
|
* [`cloudevents-http-vertx`](https://github.com/cloudevents/sdk-java/tree/master/http/vertx): Implementation of [HTTP Protocol Binding] with [Vert.x Core](https://vertx.io/)
|
||||||
|
|
||||||
|
The latest SDK version is _2.0.0-SNAPSHOT_.
|
||||||
|
|
||||||
|
## Get Started
|
||||||
|
|
||||||
|
## Use an event format
|
||||||
|
|
||||||
|
[JSON Event Format]: https://github.com/cloudevents/spec/blob/v1.0/json-format.md
|
||||||
|
[HTTP Protocol Binding]: https://github.com/cloudevents/spec/blob/v1.0/http-protocol-binding.md
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
<relativePath>../../</relativePath>
|
<relativePath>../../</relativePath>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>http-vertx</artifactId>
|
<artifactId>cloudevents-http-vertx</artifactId>
|
||||||
<name>CloudEvents - Vert.x Http Integration</name>
|
<name>CloudEvents - Vert.x Http Integration</name>
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue