Skip to content

Commit 2a28790

Browse files
committed
doc: updated readme
1 parent 793e296 commit 2a28790

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
## Implementation of Standard Webhooks for .NET Core
44

5+
StandardWebhooks is an implementation of the [Standard Webhooks specification](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md)
6+
initiated by Svix and supported by other industry participants including Zapier, Twilio, ngrok and Kong.
7+
8+
This repo extends the [C# reference implementation](https://github.com/standard-webhooks/standard-webhooks/tree/main/libraries/csharp),
9+
providing a maintained (nuget package) along with some helpful features for ASP.NET Core developers.
10+
11+
It is supported on all current .NET Core platforms (.NET 6.0, .NET 8.0).
512

613
### Generating HttpContent for a Webhook
714
```csharp
@@ -49,6 +56,14 @@ Two standard `WebhookConfigurationOptions` configurations are provided as static
4956
`WebhookConfigurationOptions.Svix`, the former for the HTTP headers as described in the Standard Webhooks specification and
5057
the latter for the headers used by Svix. The default configuration if no options are supplied is `WebhookConfigurationOptions.StandardWebhooks`.
5158

59+
## Questions and Answers
60+
Please raise any issues or questions via the [Issues page on GitHub](https://github.com/codefactors/StandardWebhooks/issues).
61+
62+
## Roadmap
63+
Currently the library doesn't provide any support for sending messages, beyond the ability to create an `HttpContent` instance
64+
from the message payload. The plan is to extent the library to support message transmission using `HttpClient`/`IHttpClientFactory`,
65+
leveraging the retry capabilites of the [Polly](https://github.com/App-vNext/Polly) package.
66+
5267
## Acknowledgements
5368

5469
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.

0 commit comments

Comments
 (0)