Skip to content

Commit f18eb9f

Browse files
committed
Improved documentation
Added embedded package icon
1 parent eed3688 commit f18eb9f

File tree

3 files changed

+15
-19
lines changed

3 files changed

+15
-19
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818

1919
## ⭐️⭐️⭐️ Enjoying This Library? Please Star Our Repo! ⭐️⭐️⭐️
2020

21-
If this SDK helps you ship features faster, we'd love your support! By starring our GitHub repository, you help us gauge how widely it's used and which features and improvements to prioritize next. Every star makes a difference — thank you for helping steer the future of this SDK!
21+
If this SDK helps you ship features faster, we'd love your support! By starring our [GitHub repository](https://github.com/verifalia/verifalia-csharp-sdk/), you help us gauge how widely it's used and which features and improvements to prioritize next. Every star makes a difference — thank you for helping steer the future of this SDK!
2222

23-
To learn more about Verifalia, please visit [https://verifalia.com][0].
23+
To learn more about Verifalia, please visit [https://verifalia.com](https://verifalia.com/).
2424

2525
---
2626

2727
# Table of Contents
2828

2929
<!-- TOC -->
3030
* [Adding Verifalia API Support to Your .NET Solution](#adding-verifalia-api-support-to-your-net-solution)
31-
* [From an IDE](#from-an-ide-)
31+
* [From an IDE](#from-an-ide)
3232
* [Rider](#rider)
3333
* [Visual Studio](#visual-studio)
3434
* [Visual Studio Code](#visual-studio-code)
@@ -82,7 +82,7 @@ To learn more about Verifalia, please visit [https://verifalia.com][0].
8282

8383
This SDK is available as a NuGet package, the package manager for .NET. The best and easiest way to add the SDK library to your .NET project is to use the NuGet package manager in your favorite IDE.
8484

85-
## From an IDE
85+
## From an IDE
8686

8787
### Rider
8888

@@ -102,22 +102,22 @@ From within Visual Studio Code, you can install the **Verifalia** NuGet package
102102

103103
## Manual Download and Compilation
104104

105-
As an alternative to using NuGet, you can [download the SDK source project from GitHub][1], extract it to a folder of your choice, and add a reference from your project to the Verifalia SDK project. The SDK project is written in C# but can be referenced and used with any other .NET language, including Visual Basic (VB.NET), C++/CLI, J#, IronPython, IronRuby, F#, and PowerShell.
105+
As an alternative to using NuGet, you can [download the SDK source project from GitHub](https://github.com/verifalia/verifalia-csharp-sdk/archive/master.zip), extract it to a folder of your choice, and add a reference from your project to the Verifalia SDK project. The SDK project is written in C# but can be referenced and used with any other .NET language, including Visual Basic (VB.NET), C++/CLI, J#, IronPython, IronRuby, F#, and PowerShell.
106106

107-
Learn more at [https://verifalia.com][0].
107+
Learn more at [https://verifalia.com](https://verifalia.com/).
108108

109109
# Authentication
110110

111-
Authentication to the Verifalia API is performed using the credentials of a Verifalia user account. While you can use the same credentials you used to register your Verifalia account for API access, for security reasons, we strongly recommend [creating and using a dedicated user account][3] for API operations. This approach allows you to assign only the specific permissions needed for your application.
111+
Authentication to the Verifalia API is performed using the credentials of a Verifalia user account. While you can use the same credentials you used to register your Verifalia account for API access, for security reasons, we strongly recommend [creating and using a dedicated user account](https://app.verifalia.com/#/users/new) for API operations. This approach allows you to assign only the specific permissions needed for your application.
112112

113-
If you don't have a Verifalia account, you can [register for a free one][4].
113+
If you don't have a Verifalia account, you can [register for a free one](https://verifalia.com/sign-up).
114114

115115
The Verifalia API supports multiple authentication methods:
116116
- **Basic authentication**: Ideal for server-to-server communications
117117
- **Bearer token authentication**: Useful for browser apps and client-to-server communications
118118
- **X.509 client certificate**: Provides the highest level of security
119119

120-
The sections below describe each authentication method in detail. For more information about authenticating to the Verifalia API, see the API reference documentation at [https://verifalia.com/developers#authentication][2].
120+
The sections below describe each authentication method in detail. For more information about authenticating to the Verifalia API, see the API reference documentation at [https://verifalia.com/developers#authentication](https://verifalia.com/developers/authentication).
121121

122122
## Basic Authentication
123123

@@ -559,7 +559,7 @@ Console.WriteLine($"Free daily credits: {balance.FreeCredits} (will reset in {ba
559559
// Free daily credits: 128.66 (will reset in 09:08:23)
560560
```
561561

562-
To add credit packs to your Verifalia account, visit [https://app.verifalia.com/#/credits/add][5].
562+
To add credit packs to your Verifalia account, visit [https://app.verifalia.com/#/credits/add](https://app.verifalia.com/#/credits/add).
563563

564564
## Retrieving Credits Usage Statistics
565565

@@ -935,10 +935,3 @@ Released on July 2025
935935
- Fixed cancellation token handling during email verification retrieval when issues occur
936936
- Improved documentation throughout the library
937937
- Updated code samples
938-
939-
[0]: https://verifalia.com
940-
[1]: https://github.com/verifalia/verifalia-csharp-sdk/archive/master.zip
941-
[2]: https://verifalia.com/developers/authentication
942-
[3]: https://app.verifalia.com/#/users/new
943-
[4]: https://verifalia.com/sign-up
944-
[5]: https://app.verifalia.com/#/credits/add

source/Verifalia.Api/Verifalia.Api.csproj

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
<Authors>Verifalia</Authors>
1313
<PackageTags>email validation verification real-time verifalia api sdk</PackageTags>
1414
<PackageIconUrl>https://verifalia.com/favicon.ico</PackageIconUrl>
15-
<Description>Verifalia provides a simple HTTPS-based API for validating email addresses and checking whether they are deliverable or not. This library allows to easily integrate with Verifalia and verify email addresses in real-time.</Description>
15+
<PackageIcon>package-icon.png</PackageIcon>
16+
<Description>Verifalia offers a simple HTTPS-based API that validates email addresses and determines whether they can receive emails, delivering fast and accurate results. This library makes it easy to integrate with Verifalia and verify email addresses in real-time.</Description>
1617
<Product>Verifalia SDK</Product>
1718
<LangVersion>latest</LangVersion>
1819
<RunCodeAnalysis>false</RunCodeAnalysis>
@@ -24,7 +25,7 @@
2425
<Nullable>enable</Nullable>
2526
<WarningsAsErrors>ASYNC0001;ASYNC0004;VSTHRD200</WarningsAsErrors>
2627
<NoWarn>CA1510;</NoWarn>
27-
<!-- <PackageReadmeFile>../README.md</PackageReadmeFile>-->
28+
<PackageReadmeFile>README.md</PackageReadmeFile>
2829
</PropertyGroup>
2930

3031
<PropertyGroup Condition="!('$(TargetFramework)' == 'net45' or '$(TargetFramework)' == 'net451' or '$(TargetFramework)' == 'net452')">
@@ -81,6 +82,8 @@
8182
<PrivateAssets>all</PrivateAssets>
8283
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
8384
</PackageReference>
85+
<None Include="../../README.md" Pack="true" PackagePath="/"/>
86+
<None Include="package-icon.png" Pack="true" PackagePath="/"/>
8487
</ItemGroup>
8588

8689
<ItemGroup Condition="$(DefineConstants.Contains(';USE_FLURL_3;'))">
13.8 KB
Loading

0 commit comments

Comments
 (0)