Update README getting started guide

README.md

@@ -1,19 +1,96 @@
 # Saunter
 
-Saunter is an [AsyncAPI](https://github.com/asyncapi/asyncapi) documentation generator for dotnet.
+![CI](https://github.com/tehmantra/saunter/workflows/CI/badge.svg)
+[![NuGet Badge](https://buildstats.info/nuget/saunter?includePreReleases=true)](https://www.nuget.org/packages/Saunter/)
 
 
-⚠ **This project is in the inception phase and should not be considered stable or production ready** ⚠
+Saunter is an [AsyncAPI](https://github.com/asyncapi/asyncapi) documentation generator for dotnet.
 
 
 ## Getting Started
 
 See [examples/StreetlightsAPI](examples/StreetlightsAPI).
 
 
+1. Install the Saunter package
+
+    ```
+    dotnet add package Saunter
+    ```
+
+2. In the `ConfigureServices` method of `Startup.cs`, configure Saunter.
+
+    ```csharp
+    // Add Saunter to the application services. 
+    services.AddAsyncApiSchemaGeneration(options =>
+    {
+        // Specify example type(s) from assemblies to scan.
+        options.AssemblyMarkerTypes = new[] {typeof(StreetlightMessageBus)};
+
+        // Build as much (or as little) of the AsyncApi document as you like.
+        // Saunter will generate Channels, Operations, Messages, etc, but you
+        // may want to specify Info here.
+        options.AsyncApi = new AsyncApiDocument
+        {
+            Info = new Info("Streetlights API", "1.0.0")
+            {
+                Description = "The Smartylighting Streetlights API allows you\nto remotely manage the city lights.",
+                License = new License("Apache 2.0")
+                {
+                    Url = "https://www.apache.org/licenses/LICENSE-2.0"
+                }
+            },
+            Servers =
+            {
+                { "mosquitto", new Server("test.mosquitto.org", "mqtt") }
+            }
+        };
+    });
+    ```
+
+3. Add attributes to your classes which publish or subscribe to messages.
+
+    ```csharp
+    [AsyncApi] // Tells Saunter to scan this class.
+    public class StreetlightMessageBus : IStreetlightMessageBus
+    {
+        [Channel("publish/light/measured")] // Creates a Channel
+        [PublishOperation(typeof(LightMeasuredEvent), Summary = "Inform about environmental lighting conditions for a particular streetlight.")] // A simple Publish operation.
+        public void PublishLightMeasuredEvent(Streetlight streetlight, int lumens) {}
+    ```
+
+4. Add saunter middleware to host the AsyncApi json document. In the `Configure` method of `Startup.cs`:
+
+    ```csharp
+    app.UseMiddleware<AsyncApiMiddleware>();
+    ```
+
+5. Use the published AsyncApi document:
+
+    ```json
+    // HTTP GET /asyncapi/asyncapi.json
+    {
+        // Properties from Startup.cs
+        "asyncapi": "2.0.0",
+        "info": {
+            "title": "Streetlights API",
+            "version": "1.0.0",
+            "description": "The Smartylighting Streetlights API allows you\nto remotely manage the city lights.",
+           // ...
+        },
+        // Properties generated from Attributes
+        "channels": {
+            "light/measured": {
+            "publish": {
+                "operationId": "PublishLightMeasuredEvent",
+                "summary": "Inform about environmental lighting conditions for a particular streetlight.",
+            //...
+    }
+    ```
+
 ## Contributing
 
-Feel free to get involved in the project by opening issues.
+Feel free to get involved in the project by opening issues, or submitting pull requests.
 
 
 ## Thanks