doc: updated readmes

Author: payetools

README.md

@@ -5,7 +5,7 @@
 
 ### Generating HttpContent for a Webhook
 ```csharp
-var testEntity = new TestEntity
+var myEntity = new MyEntity
 {
     Id = 1,
     Name = "Test Entity",
@@ -16,10 +16,39 @@ var webhook = new StandardWebhook(WEBHOOK_SIGNING_KEY);
 
 var sendingTime = DateTimeOffset.UtcNow;
 
-var webhookContent = webhook.MakeHttpContent(testEntity, DEFAULT_MSG_ID, sendingTime);
+var webhookContent = webhook.MakeHttpContent(myEntity, DEFAULT_MSG_ID, sendingTime);
+```
+
+### Verifying a Webhook signature
+```csharp
+// Assumes messageBody contains string representation of message content
+// and request is an HttpRequest with the Standard Webhooks headers set
 
+var webhook = new StandardWebhook(WEBHOOK_SIGNING_KEY);
+
+// Throws WebhookVerificationException if verification fails
+webhook.Verify(messageBody, request.Headers);
 ```
 
+### Factory Pattern
+The library provides `IStandardWebhookFactory` and its implementation `StandardWebhookFactory`
+which are intended for use in ASP.NET DI scenarios.  Usage:
+```csharp
+// In Program.cs, or wherever services are configured.  Optionally WebhookConfigurationOptions can be
+// provided as a second parameter to configure which header names to use.
+
+services.AddSingleton<IStandardWebhookFactory>(sp =>
+    new StandardWebhookFactory(WEBHOOK_SIGNING_KEY));
+
+// In method, add IStandardWebhookFactory as an injected parameter and then:
+var webhook = webhookFactory.CreateWebhook();
+```
+
+### Standard Configurations
+Two standard `WebhookConfigurationOptions` configurations are provided as static instances, `WebhookConfigurationOptions.StandardWebhooks` and
+`WebhookConfigurationOptions.Svix`, the former for the HTTP headers as described in the Standard Webhooks specification and
+the latter for the headers used by Svix. The default configuration if no options are supplied is `WebhookConfigurationOptions.StandardWebhooks`.
+
 ## Acknowledgements
 
 This project leverages the work of the **Standard Webhooks** project, published on Github in the [standard-webhooks](https://github.com/standard-webhooks/standard-webhooks) repository.

src/Directory.Build.props

@@ -18,7 +18,7 @@
 
 	<ItemGroup>
 		<None Include="$(SolutionDir)LICENSE.md" Pack="true" PackagePath="" />
-		<None Include="$(SolutionDir)README.md" Pack="true" PackagePath="" />
+		<None Include="$(SolutionDir)src\StandardWebhooks\README.md" Pack="true" PackagePath="" />
 	</ItemGroup>
 
 </Project>

src/StandardWebhooks/README.md

@@ -1,3 +1,6 @@
-# Standard Webhooks
-## TBD
+# StandardWebhooks
 
+`StandardWebhooks` is an implementation of the [Standard Webhooks specification](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md)
+initiated by Svix and supported by other industry participants including Zapier, Twilio, ngrok and Kong.
+
+See the repo on [GitHub](https://github.com/codefactors/StandardWebhooks) for more information and examples.