From 903114b6544b0df249dc3623f7923e3a54dd5f29 Mon Sep 17 00:00:00 2001 From: Anton Zhaparov Date: Sat, 21 Dec 2024 16:22:25 +0200 Subject: [PATCH 1/2] Added NuGet package readme files --- src/Mailtrap.Abstractions/README.md | 23 ++++++++++++++++++++++- src/Mailtrap/README.md | 21 ++++++++++++++++++++- 2 files changed, 42 insertions(+), 2 deletions(-) diff --git a/src/Mailtrap.Abstractions/README.md b/src/Mailtrap.Abstractions/README.md index fb9e4fdf..4dc54431 100644 --- a/src/Mailtrap.Abstractions/README.md +++ b/src/Mailtrap.Abstractions/README.md @@ -1 +1,22 @@ -# Official Mailtrap .NET Client - Abstractions Package +# Mailtrap.Abstractions +Provides abstractions for the Mailtrap .NET SDK. +Interfaces defined in this package are implemented by classes in the [Mailtrap](https://www.nuget.org/packages/Mailtrap) package. + +Please visit [documentation site](https://railsware.github.io/mailtrap-dotnet) for detailed documentation and usage examples. + + +## Main Types +* `Mailtrap.IMailtrapClient` +* `Mailtrap.IMailtrapClientFactory` +* `Mailtrap.Emails.IEmailClient` +* `Mailtrap.Emails.Requests.SendEmailRequest` +* `Mailtrap.Emails.Responses.SendEmailResponse` + + +## Related Packages +* [Mailtrap](https://www.nuget.org/packages/Mailtrap) + + +## Contributing +`Mailtrap.Abstractions` package is released as open source under the [MIT license](https://licenses.nuget.org/MIT). +Bug reports and contributions are welcome at the [GitHub repository](https://github.com/railsware/mailtrap-dotnet). diff --git a/src/Mailtrap/README.md b/src/Mailtrap/README.md index e6a6113e..1aaad265 100644 --- a/src/Mailtrap/README.md +++ b/src/Mailtrap/README.md @@ -1 +1,20 @@ -# Official Mailtrap .NET Client +# Mailtrap +Official Mailtrap .NET SDK library. + +Please visit [documentation site](https://railsware.github.io/mailtrap-dotnet) for detailed documentation and usage examples. + + +## Main Types +* `Mailtrap.MailtrapClient` +* `Mailtrap.MailtrapClientFactory` +* `Mailtrap.Configuration.MailtrapClientOptions` +* `Mailtrap.Emails.EmailClient` + + +## Related Packages +* [Mailtrap.Abstractions](https://www.nuget.org/packages/Mailtrap.Abstractions) + + +## Contributing +`Mailtrap` package is released as open source under the [MIT license](https://licenses.nuget.org/MIT). +Bug reports and contributions are welcome at the [GitHub repository](https://github.com/railsware/mailtrap-dotnet). From 00870165f62bb4b69bb78c751bec8c394164ce3b Mon Sep 17 00:00:00 2001 From: Anton Zhaparov Date: Tue, 24 Dec 2024 18:02:52 +0200 Subject: [PATCH 2/2] Update src/Mailtrap/README.md Co-authored-by: Marcin Klocek --- src/Mailtrap/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Mailtrap/README.md b/src/Mailtrap/README.md index 1aaad265..eabd0d97 100644 --- a/src/Mailtrap/README.md +++ b/src/Mailtrap/README.md @@ -1,5 +1,5 @@ # Mailtrap -Official Mailtrap .NET SDK library. +Official Mailtrap .NET SDK. Please visit [documentation site](https://railsware.github.io/mailtrap-dotnet) for detailed documentation and usage examples.