Increase version, add readme

Author: tinohager

docs/README.md

@@ -0,0 +1,35 @@
+# Nager.EmailAuthentication
+
+Nager.EmailAuthentication is a .NET library designed to parse and validate DMARC and DKIM easily.
+With built-in support for error handling and validation, this library simplifies working with email authentication configurations.
+
+## Features
+
+- Parse DMARC records with comprehensive validation.
+- Parse DKIM Public Key records with comprehensive validation.
+- Parse DKIM Signatures with comprehensive validation.
+- Parse SPF records
+- Identify and report errors in DMARC configurations.
+- Identify and report errors in DKIM configurations.
+
+## Examples
+
+**Parsing a DMARC Record**
+```cs
+var dmarcRecordRaw = "v=DMARC1; p=reject;";
+if (!DmarcRecordParser.TryParse(dmarcRecordRaw, out var dmarcRecord))
+{
+}
+```
+
+**Handling Validation Errors**
+```cs
+var dmarcRecord = "v=DMARC1; p=invalid;";
+if (!DmarcRecordDataFragmentParser.TryParse(dmarcRecord, out var dmarcDataFragment, out var parsingResults))
+{
+}
+```
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

src/Nager.EmailAuthentication/Nager.EmailAuthentication.csproj

@@ -13,16 +13,20 @@
 
     <!--<PackageIcon>logo.png</PackageIcon>-->
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <!--<PackageReadmeFile>README.md</PackageReadmeFile>-->
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <!--<PackageReleaseNotes></PackageReleaseNotes>-->
     <PackageProjectUrl>https://github.com/nager/Nager.EmailAuthentication</PackageProjectUrl>
     <PackageTags>EmailAuthentication Dmarc Dkim</PackageTags>
 
     <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
 
-    <Version>3.0.0-alpha</Version>
+    <Version>3.0.0</Version>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\docs\README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+	
   <ItemGroup>
     <PackageReference Include="Nager.KeyValueParser" Version="1.1.0" />
   </ItemGroup>