Update documentation

README.md

@@ -7,10 +7,95 @@ The tools hosted in this repository aim to provide the toolset necessary to deve
 
 ## AsyncAPI Metamodel
 
-Below you can find the simplified AsyncAPI Metamodel Derived from the AsyncAPI Xtext Grammar.
+Below you can find the simplified [AsyncAPI v2.0.0](https://www.asyncapi.com/docs/specifications/2.0.0/) Metamodel Derived from the AsyncAPI Xtext Grammar.
 
 ![AsyncAPI Metamodel](plugins/io.github.abelgomez.asyncapi/model/AsyncApi.png)
 
+## Installation
+
+To install the toolkit use the following update site:
+
+> https://som-research.github.io/asyncapi-toolkit/updates
+
+### Prerequisites
+
+* The toolkit requires [Eclipse 4.12 (2019-06)](https://download.eclipse.org/eclipse/downloads/drops4/R-4.12-201906051800/) or [above](https://download.eclipse.org/eclipse/downloads/).
+* A MQTT broker (e.g. [mosqutitto](https://mosquitto.org/download/)) is needed for the Example project to be executable.
+
+## Quick Start Guide
+
+To start using the toolkit, just install the plugins, using the previous Update site:
+
+![AsyncAPI Toolkit Update Site](doc/update_site.png)
+
+After installation is complete, a new wizard will appear in the `New Project` dialog:
+
+![New Project Wizard - Step 1](doc/wizard1.png)
+
+Select _AsyncAPI Project_, set a project name, and continue.
+
+![New Project Wizard - Step 2](doc/wizard2.png)
+
+After that, the _Streetlights API_ template project will appear. The _Streetlights API_ template contains a fully working example (provided a mqtt broker is running in localhost) demonstrating the capabilities of the framework.
+
+![New Project Wizard - Step 3](doc/wizard3.png)
+
+Finally, the wizard can be completed.
+
+![New Project Wizard - Step 4](doc/wizard4.png)
+
+After that, A new project with the following contents will appear in the workspace.
+
+![Streetlights API Project Contents](doc/project_contents.png)
+
+Pay special attention to the following files:
+
+* `src/streetlights/StreetlightsAPI.asyncapi` is an example specification of an API using the JSON format of teh AsyncAPI specification. Code in `src-gen` will be generated from the specification contained in this file.
+
+* `src/main/MainExample.java` is an example program demonstrating how to use the generated code, whichj provides an internal DSL based on fluent APIs to generate messages, and to publish and subscribe them. The example code is the following:
+
+```Java
+package main;
+
+import java.text.MessageFormat;
+import java.time.LocalDateTime;
+import java.util.UUID;
+
+import schemas.LightMeasuredPayload;
+import smartylighting.streetlights._1._0.event.__streetlightId_.lighting.measured.PublishLightMeasured;
+import smartylighting.streetlights._1._0.event.__streetlightId_.lighting.measured.PublishLightMeasured.PublishLightMeasuredParams;
+import smartylighting.streetlights._1._0.event.__streetlightId_.lighting.measured.SubscribeLightMeasured;
+
+public class MainExample {
+	public static void main(String[] args) throws Exception {
+
+		SubscribeLightMeasured.subscribe((params, message) -> {
+			System.err.println(MessageFormat.format(
+					"Subscription to ''{0}'' with ID ''{1}'':\n{2} lumens at {3}",
+					SubscribeLightMeasured.TOPIC_ID, params.getStreetlightId(), message.getLumens(), message.getSentAt()));
+		});
+
+		for (int i = 0; i < 3; i++) {
+			LightMeasuredPayload payload = PublishLightMeasured.payloadBuilder()
+					.withLumens(10)
+					.withSentAt(LocalDateTime.now().toString())
+					.build();
+
+			PublishLightMeasuredParams params = PublishLightMeasuredParams.create()
+					.withStreetlightId(UUID.randomUUID().toString());
+
+			System.out.println(MessageFormat.format(
+					"Publishing at ''{0}'':\n{1}",
+					PublishLightMeasured.expand(params), payload.toJson(true)));
+
+			PublishLightMeasured.publish(payload, params);
+		}
+
+		SubscribeLightMeasured.unsubscribe();
+	}
+}
+```
+
 ## AsyncAPI Grammar
 
 See the simplified AsyncAPI/JSON Xtext Grammar in the file [`plugins/io.github.abelgomez.asyncapi/src/io/github/abelgomez/asyncapi/AsyncApi.xtext`](plugins/io.github.abelgomez.asyncapi/src/io/github/abelgomez/asyncapi/AsyncApi.xtext).