Skip to content

Commit b005544

Browse files
committed
update docs
1 parent f30815b commit b005544

File tree

2 files changed

+59
-18
lines changed

2 files changed

+59
-18
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to 'SocketLabs.EventWebhooks.Extensions'
1+
# Contributing to SocketLabs.EventWebhooks.Extensions
22

33
If you discover issues, have ideas for improvements or new features,
44
please report them to the [issue tracker](https://github.com/socketlabs/SocketLabs.EventWebhooks.Extensions/issues) of the repository or
@@ -27,7 +27,7 @@ You can request a new feature by submitting an issue to our
2727
consider what kind of change it is:
2828

2929
* **Major Changes** that you wish to contribute to the project should be
30-
discussed first with `socketlabs-csharp` contributors in an issue or pull request so
30+
discussed first with `SocketLabs.EventWebhooks.Extensions` contributors in an issue or pull request so
3131
that we can develop a proper solution and better coordinate our efforts,
3232
prevent duplication of work, and help you to craft the change so that it is
3333
successfully accepted into the project.

README.md

Lines changed: 57 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,80 @@
22

33
[![Build status][build-status]][build]
44
# SocketLabs.EventWebhooks.Extensions
5-
> If you are reading, someone used a template and never updated the readme.
6-
>
7-
>Please update me 😢.
5+
> Library to make consuming SocketLabs webhooks easier.
86
97
## Getting Started
108
### Prerequisites
119

1210
* Visual Studio or VSCode
13-
* .NET 7
11+
* .NET 8
1412

15-
### Building
13+
### Usage
1614

17-
1. CI builds are configured in [Azure DevOps][build]
15+
Import using dotnet CLI or the Package Manager console in Visual Studio
1816

19-
### Installation
17+
#### dotnet cli
2018

21-
1. CI Deployments are deployed automatically in [Azure DevOps Releases][release]
19+
```shell
20+
dotnet add package SocketLabs.EventWebhooks.Extensions
21+
```
22+
23+
#### Package Manager
24+
25+
```powershell
26+
Install-Package SocketLabs.EventWebhooks.Extensions
27+
```
28+
29+
Inject the webhook services
30+
31+
```csharp
32+
var builder = WebApplication.CreateBuilder(args);
33+
34+
// Code removed for brevity ...
35+
36+
// Add the webhook endpoints
37+
builder.Services.AddWebhookEndpoints(builder.Configuration);
38+
39+
// Add custom implementation of IWebhookEventHandler
40+
builder.Services.AddSingleton<IWebhookEventHandler, WebhookEventHandler>();
41+
42+
```
43+
44+
Add webhook configurations
45+
46+
#### appsettings.json
47+
```javascript
48+
{
49+
"WebhookOptions": {
50+
"WebhookEndpoints": [
51+
{
52+
"Name": "cc0b4dc6-d867-49f5-9d8e-8357997789af",
53+
"SecretKey": "Z123456AbcD1234563Ef"
54+
}
55+
]
56+
}
57+
}
58+
```
59+
60+
Configure Endpoint URL in portal
61+
62+
```
63+
https://example.com/api/v1/webhookevents/cc0b4dc6-d867-49f5-9d8e-8357997789af
64+
```
2265

2366
### Release History
2467

2568
* 1.0.0 Initial Release
2669

27-
### Documentation
70+
### License
2871

29-
Documentation is available in [Confluence][docs]
72+
[MIT License](LICENSE.md)
3073

31-
### License
74+
### Contributing
3275

33-
This code base is confidential and not for public distribution at this time.
76+
[Contributor Guidelines](CONTRIBUTING.md)
3477

3578
<!-- MARKDOWN LINKS & IMAGES -->
3679
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
37-
[build-status]: https://dev.azure.com/socketlabs/ServiceProvider/_apis/build/status/SocketLabs.Template.Worker-CI?branchName=main
38-
[build]: https://dev.azure.com/socketlabs/SelfService/_build?definitionId=0
39-
[release]: https://dev.azure.com/socketlabs/SelfService/_release?view=all&_a=releases&definitionId=0
40-
[docs]: https://socketlabs.atlassian.net/wiki/spaces/SSR/
80+
[build-status]: https://dev.azure.com/socketlabs/Public%20Projects/_apis/build/status/SocketLabs.EventWebhooks.Extensions-CI?branchName=main
81+
[build]: https://dev.azure.com/socketlabs/Public%20Projects/_build/latest?definitionId=170

0 commit comments

Comments
 (0)