Skip to content

Commit fa9a356

Browse files
authored
Optimize readme (#262)
* Migrate source and example directories to lowercase Renamed all 'Src' and 'Examples' directories to 'src' and 'examples' for consistency and to follow common directory naming conventions. Updated GitHub Actions workflows to use the new lowercase paths and upgraded actions/checkout and actions/setup-dotnet to v5. * Update SmtpServer.sln * Fix project reference paths to use lowercase 'src' Updated project reference paths in SampleApp and WorkerService csproj files to use 'src' instead of 'Src' for consistency and to avoid case sensitivity issues on some file systems. * Update README and project description for clarity Improved the README with clearer language, better formatting, and added installation instructions. Enhanced the project description in the .csproj file to better reflect the features and capabilities of the SMTP server.
1 parent 064c9af commit fa9a356

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,33 @@
22

33
[![NuGet](https://img.shields.io/nuget/v/SmtpServer.svg)](https://www.nuget.org/packages/SmtpServer/)
44

5-
SmtpServer is a simple, but highly functional SMTP server implementation. Written entirely in C# it takes full advantage of the .NET TPL to achieve maximum performance.
5+
**SmtpServer** is a lightweight yet powerful SMTP server implementation in C#.
6+
Built entirely in .NET, it leverages the Task Parallel Library (TPL) for maximum performance.
67

7-
SmtpServer is available via [NuGet](https://www.nuget.org/packages/SmtpServer/)
8-
9-
# Whats New?
8+
## 🆕 What's New?
109

1110
Check the [Changelog](https://github.com/cosullivan/SmtpServer/blob/master/CHANGELOG.md)
1211

13-
# What does it support?
12+
## ⚡ Supported ESMTP Extensions
1413

15-
SmtpServer currently supports the following ESMTP extensions:
14+
SmtpServer currently supports the following extensions:
1615

1716
- STARTTLS
1817
- SIZE
1918
- PIPELINING
2019
- 8BITMIME
2120
- AUTH PLAIN LOGIN
2221

23-
# How can it be used?
22+
## Installation
23+
24+
The package is available on [NuGet](https://www.nuget.org/packages/SmtpServer)
25+
```powershell
26+
PM> install-package SmtpServer
27+
```
28+
29+
## 🚀 Getting Started
2430

25-
At its most basic, it only takes a few lines of code for the server to be listening to incoming requests.
31+
Starting a basic SMTP server requires only a few lines of code:
2632

2733
```cs
2834
var options = new SmtpServerOptionsBuilder()
@@ -34,7 +40,7 @@ var smtpServer = new SmtpServer.SmtpServer(options, ServiceProvider.Default);
3440
await smtpServer.StartAsync(CancellationToken.None);
3541
```
3642

37-
# What hooks are provided?
43+
### What hooks are provided?
3844

3945
There are three hooks that can be implemented; IMessageStore, IMailboxFilter, and IUserAuthenticator.
4046

src/SmtpServer/SmtpServer.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<AssemblyName>SmtpServer</AssemblyName>
77
<RootNamespace>SmtpServer</RootNamespace>
88
<Version>10.0.1</Version>
9-
<Description>.NET SmtpServer</Description>
9+
<Description>High-performance, flexible SMTP server implementation for .NET with support for ESMTP, TLS, authentication, and custom message handling.</Description>
1010
<Authors>Cain O'Sullivan</Authors>
1111
<Copyright>2015-2023</Copyright>
1212
<RepositoryUrl>https://github.com/cosullivan/SmtpServer</RepositoryUrl>

0 commit comments

Comments
 (0)