Update documentation

[martincostello]

As part of the introduction of the new builder API (see #471), the README documentation, samples etc. need to be updated to use the new API.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[PeterKneale]

More diagrams

I'd like to see some diagrams that explain how the various options present in the bus configuration map to different architectures. Ideally these might be described using a few different 'patterns'.
ie:
(Note: im not even sure if the below is right - its just an example)

Configuration Pattern Pub/Sub

• publisher configuration

                config.Publications(x =>
                {
                    x.WithTopic<X>();
                });

• subscriber1 configuration

                config.Subscriptions(x =>
                {
                   x.ForTopic<X>();
                });

• subscriber2 configuration

                config.Subscriptions(x =>
                {
                   x.ForTopic<X>();
                });

Resulting architecture

Producing the diagrams

• PlantUML sequence diagrams seem to lend themselves to this kind of documentation.
• They are plain text and the markup is easily learnt just through experimentation
• They are linkable
• There is a website that renders the below to an image: https://www.planttext.com/
• There is a visual studio code plugin that can render them using a plantuml server
• There is a docker image for the server

 docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

PlantUML used to produce the above

@startuml component

title PubSub using JustSaying and AWS SNS/SQS
hide footbox
skinparam BackgroundColor #EEEBDC
skinparam BoxPadding 20
skinparam ParticipantPadding 20

box "Publishing\nApplication" #lightgrey
    participant Publisher order 1
end box
box "AWS" #orange
    participant "AWS SNS Topic" as SNS_Publisher order 2
    participant "AWS SQS Queue #1" as SQS_Subscriber1 order 3
    participant "AWS SQS Queue #2" as SQS_Subscriber2 order 4
end box
box "Subscribing\nApplication #1" #lightgrey
    participant "Subscriber" as Subscriber_1 order 5
end box
box "Subscribing\nApplication #2" #lightgrey
    participant "Subscriber" as Subscriber_2 order 6
end box

== Publishing ==
group publishing
    Publisher-[#Green]>SNS_Publisher: Publish message to SNS Topic
    SNS_Publisher-[#gray]>SQS_Subscriber1: Deliver message to SQS Queue
    SNS_Publisher-[#gray]>SQS_Subscriber2: Deliver message to SQS Queue
    return ok
end

== Polling ==
group subscriber polling
    SQS_Subscriber1<[#Green]-Subscriber_1: List messages
    return Message returned
end 
group subscriber polling
    SQS_Subscriber2<[#Green]-Subscriber_2: List messages
    return Message returned
end 

== Acknowledging ==
group subscriber acknowledging
    SQS_Subscriber1<-[#Green]-Subscriber_1 !! : Delete message
end 
group subscriber acknowledging
    SQS_Subscriber2<-[#Green]-Subscriber_2 !! : Delete message
end 
@enduml

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

Closed automatically due to inactivity.