Add package READMEs. Fixes #1053

Author: bgrainger

docs/UsingLog4netLogging.md

@@ -2,13 +2,13 @@
 
 To integrate MySqlConnector with log4net, add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
 
-```
+```csharp
 MySqlConnectorLogManager.Provider = new Log4netLoggerProvider();
 ```
 
 To reduce the verbosity of MySqlConnector logging, add the following element to your log4net config:
 
-```
+```xml
 <log4net>
   ...
   <logger name="MySqlConnector">

docs/UsingMicrosoftExtensionsLogging.md

@@ -2,6 +2,6 @@
 
 To integrate MySqlConnector with Microsoft.Extensions.Logging, add the following line of code to your `Startup.Configure` method (before any `MySqlConnector` objects have been used):
 
-```
+```csharp
 MySqlConnectorLogManager.Provider = new MicrosoftExtensionsLoggingLoggerProvider(loggerFactory);
 ```

docs/UsingNLogLogging.md

@@ -2,6 +2,6 @@
 
 To integrate MySqlConnector with [NLog](http://nlog-project.org/), add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
 
-```
+```csharp
 MySqlConnectorLogManager.Provider = new NLogLoggerProvider();
 ```

docs/UsingSerilogLogging.md

@@ -2,6 +2,6 @@
 
 To integrate MySqlConnector with [Serilog](https://serilog.net/), add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
 
-```
+```csharp
 MySqlConnectorLogManager.Provider = new SerilogLoggerProvider();
 ```

src/MySqlConnector.Authentication.Ed25519/MySqlConnector.Authentication.Ed25519.csproj

@@ -4,13 +4,18 @@
     <TargetFrameworks>net45;netstandard2.0</TargetFrameworks>
     <Title>MySqlConnector Ed25519 Authentication Plugin</Title>
     <Description>Implements the client_ed25519 authentication plugin for MariaDB.</Description>
-    <Copyright>Copyright 2019 Bradley Grainger</Copyright>
+    <Copyright>Copyright 2019–2021 Bradley Grainger</Copyright>
     <Authors>Bradley Grainger</Authors>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>mariadb;mysqlconnector;authentication;ed25519</PackageTags>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\MySqlConnector\MySqlConnector.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="docs\README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>

src/MySqlConnector.Authentication.Ed25519/docs/README.md

@@ -0,0 +1,7 @@
+## About
+
+This package implements the `client_ed25519` [authentication plugin for MariaDB](https://mariadb.com/kb/en/authentication-plugin-ed25519/).
+
+## How to Use
+
+Call `Ed25519AuthenticationPlugin.Install()` from your application startup code to enable it.

src/MySqlConnector.Logging.Microsoft.Extensions.Logging/MySqlConnector.Logging.Microsoft.Extensions.Logging.csproj

@@ -6,6 +6,7 @@
     <Description>Writes MySqlConnector logging output to Microsoft.Extensions.Logging with one line of code.</Description>
     <Copyright>Copyright 2017–2021 Bradley Grainger</Copyright>
     <Authors>Bradley Grainger</Authors>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>mysql;mysqlconnector;async;ado.net;database;netcore;logging</PackageTags>
     <Nullable>enable</Nullable>
   </PropertyGroup>
@@ -18,4 +19,8 @@
     <ProjectReference Include="..\MySqlConnector\MySqlConnector.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="docs\README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>

src/MySqlConnector.Logging.Microsoft.Extensions.Logging/docs/README.md

@@ -0,0 +1,11 @@
+## About
+
+This package integrates MySqlConnector logging with the Microsoft.Extensions.Logging framework.
+
+## How to Use
+
+Add the following line of code to your `Startup.Configure` method (before any `MySqlConnector` objects have been used):
+
+```csharp
+MySqlConnectorLogManager.Provider = new MicrosoftExtensionsLoggingLoggerProvider(loggerFactory);
+```

src/MySqlConnector.Logging.NLog/MySqlConnector.Logging.NLog.csproj

@@ -6,6 +6,7 @@
     <Description>Writes lightly-structured MySqlConnector logging output to NLog.</Description>
     <Copyright>Copyright 2018–2021 Bradley Grainger</Copyright>
     <Authors>Rolf Kristensen</Authors>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>mysql;mysqlconnector;async;ado.net;database;netcore;NLog;logging</PackageTags>
     <Nullable>enable</Nullable>
   </PropertyGroup>
@@ -18,4 +19,8 @@
     <ProjectReference Include="..\MySqlConnector\MySqlConnector.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="docs\README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
 </Project>

src/MySqlConnector.Logging.NLog/docs/README.md

@@ -0,0 +1,11 @@
+## About
+
+This package integrates MySqlConnector logging with [NLog](https://www.nuget.org/packages/NLog/).
+
+## How to Use
+
+Add the following line of code to your application startup routine (before any `MySqlConnector` objects have been used):
+
+```csharp
+MySqlConnectorLogManager.Provider = new NLogLoggerProvider();
+```