Skip to content

Commit 8dd613d

Browse files
authored
Update README.md
Typo fixes
1 parent 69bf25d commit 8dd613d

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Anyway, a typical implementation consists of the following elements:
1717
* The webhook payload includes properties that describe the type of event and the time-stamp of the occurrence
1818
* An optional signature in the header of the request or a query-string parameter ensures the authenticity of the caller
1919

20-
I tried to express the concepts in more details in [this page](docs/concept_webhook.md) within this repository (without any ambition to be pedagogic).
20+
I tried to express the concepts in more detail in [this page](docs/concept_webhook.md) within this repository (without any ambition to be pedagogic).
2121

2222
## The Framework Libraries
2323

@@ -47,7 +47,7 @@ To get the latest pre-release versions of the packages you can restore from the
4747

4848
## Documentation
4949

50-
We would like to help you getting started with this framework and to eventually extend it: please refer to the **[Documentation](docs/README.md)** section, or to the **[Official Website](https://webhooks.deveel.org/)** that we have produced for you.
50+
We would like to help you get started with this framework and to eventually extend it: please refer to the **[Documentation](docs/README.md)** section, or to the **[Official Website](https://webhooks.deveel.org/)** that we have produced for you.
5151

5252
The easiest way to get started is to follow the **[Getting Started](docs/getting-started.md)** guide, but you can also refer to the **[Frequently Asked Questions](docs/FAQS.md)** section to get answers to the most common questions.
5353

@@ -58,17 +58,17 @@ While working on a .NET Core 3.1/.NET 5 _PaaS_ (_Platform-as-a-Service_) project
5858
* [Microsoft's ASP.NET Webhooks](https://github.com/aspnet/WebHooks) project was archived and moved back to the [Microsoft ASP Labs](https://github.com/aspnet/AspLabs/tree/main/src/WebHooks) (that has no visibility on its release), aiming one day to provide compatibility with .NET Core (which eventually evolved, becoming LTS)
5959
* Both Microsoft's projects (the _legacy_ and the _experimental_ ones) are not compatible with the latest .NET stacks (_.NET 5_ / _.NET 6_)
6060
* Microsoft's _experimental_ projects never implemented any capability of handling subscriptions, and eventually removed the _sender_ capability, focusing exclusively on _receivers_
61-
* Alternative implementations providing similar capabilities are embedded and organic part of larger frameworks (like [ASP.NET Boilerplate](https://github.com/aspnetboilerplate/aspnetboilerplate)), that would have forced me to adopt the the entirety of such frameworks, beyond my design intentions
61+
* Alternative implementations providing similar capabilities are embedded and organic parts of larger frameworks (like [ASP.NET Boilerplate](https://github.com/aspnetboilerplate/aspnetboilerplate)), that would have forced me to adopt the the entirety of such frameworks, beyond my design intentions
6262

6363
## Simple Usage Example
6464

65-
The **[documentation of the framework](docs/README.md)** will provide you more details on the requirements, configurations, usage and extensibility of the framework.
65+
The **[documentation of the framework](docs/README.md)** will provide you with more details on the requirements, configurations, usage and extensibility of the framework.
6666

67-
Anyway, to help you getting started with the framework, please consider the following examples that show how to create a simple webhook management service, that handle subscriptions and notifications, and a client receiver.
67+
Anyway, to help you get started with the framework, please consider the following examples that show how to create a simple webhook management service, that handle subscriptions and notifications, and a client receiver.
6868

6969
### Subscriptions and Notifications
7070

71-
As a provider of service, this library provide functions to handle the two main aspects of the webhook pattern:
71+
As a provider of service, this library provides functions to handle the two main aspects of the webhook pattern:
7272

7373
* **Subscriptions**: the capability of a client to subscribe to a specific event, providing an endpoint to be notified
7474
* **Notifications**: the capability of a server to send notifications to the subscribed endpoints
@@ -87,12 +87,12 @@ namespace Example {
8787

8888
// ...
8989
90-
builder.Services.AddSubscriptions<MongoWebhookSubscription>(subs => {
90+
builder.Services.AddWebhookSubscriptions<MongoWebhookSubscription>(subs => {
9191
subs.UseMongoDb("mongodb://localhost:27017")
9292
.UseSubscriptionResolver();
9393
});
9494

95-
builder.Services.AddNotifier<MyWebhook>(notifier => {
95+
builder.Services.AddWebhookNotifier<MyWebhook>(notifier => {
9696
notifier.UseSender(sender => {
9797
sender.Configure(options => {
9898
options.Timeout = TimeSpan.FromSeconds(30);
@@ -108,7 +108,7 @@ namespace Example {
108108
app.MapPost("/webhooks", async (HttpContext context,
109109
[FromServices] IWebhookSender<MyWebhook> sender, [FromBody] MyWebhookModel webhook) => {
110110
var destination = webhook.Destination.ToWebhookDestination();
111-
var result = await sender.SendAsync(destination webhook, context.HttpContext.RequestAborted);
111+
var result = await sender.SendAsync(destination, webhook, context.HttpContext.RequestAborted);
112112

113113
// ...
114114
@@ -172,9 +172,9 @@ namespace Example {
172172

173173
## Contribute
174174

175-
Contributions to open-source projects, like **Deveel Webhooks**, is generally driven by interest in using the product and services, if they would respect some of the expectations we have to its functions.
175+
Contributions to open-source projects, like **Deveel Webhooks**, is generally driven by interest in using the product and services, if they would respect some of the expectations we have for its functions.
176176

177-
The best ways to contribute and improve the quality of this project is by trying it, filing issues, joining in design conversations, and make pull-requests.
177+
The best ways to contribute and improve the quality of this project are by trying it, filing issues, joining in design conversations, and making pull-requests.
178178

179179
Please refer to the [Contributing Guidelines](CONTRIBUTING.md) to receive more details on how you can contribute to this project.
180180

@@ -188,4 +188,4 @@ We aim to address most of the questions you might have by providing [documentati
188188

189189
## License Information
190190

191-
This project is released under the [Apache 2 Open-Source Licensing agreement](https://www.apache.org/licenses/LICENSE-2.0).
191+
This project is released under the [Apache 2 Open-Source Licensing agreement](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)