From bf3514459b5ab59bccb83e2f28b0896ad6a4870c Mon Sep 17 00:00:00 2001 From: Francesco Guardiani Date: Mon, 27 Apr 2020 19:47:23 +0200 Subject: [PATCH] Docs (#135) * Added jemoji Signed-off-by: Francesco Guardiani * Renamed vertx module to cloudevents-http-vertx Fixed docs Signed-off-by: Francesco Guardiani --- docs/_config.yml | 4 +++- docs/index.md | 32 +++++++++++++++++++++++++++++--- http/vertx/pom.xml | 2 +- 3 files changed, 33 insertions(+), 5 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index c7418817..213386ad 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,3 @@ -theme: jekyll-theme-slate \ No newline at end of file +theme: jekyll-theme-slate +plugins: + - jemoji diff --git a/docs/index.md b/docs/index.md index 491bf308..75d9e2b3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,12 @@ 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: @@ -12,10 +17,31 @@ Supported features of the specification: | AMQP Protocol Binding | :x: | :x: | | AVRO Event Format | :x: | :x: | | 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: | -| - [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: | | MQTT Protocol Binding | :x: | :x: | | NATS Protocol Binding | :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 diff --git a/http/vertx/pom.xml b/http/vertx/pom.xml index 6987f5d5..adbe3194 100644 --- a/http/vertx/pom.xml +++ b/http/vertx/pom.xml @@ -24,7 +24,7 @@ ../../ - http-vertx + cloudevents-http-vertx CloudEvents - Vert.x Http Integration jar