Update README.md

DevTeam · Jul 24, 2024 · 4d125b4 · 4d125b4
1 parent ac3a463
commit 4d125b4
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 20 deletions.
diff --git a/Pure.DI.sln b/Pure.DI.sln
@@ -72,6 +72,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "readme", "readme", "{24E449
 		readme\BlazorWebAssemblyAppPageTemplate.md = readme\BlazorWebAssemblyAppPageTemplate.md
 		readme\MauiPageTemplate.md = readme\MauiPageTemplate.md
 		readme\MinimalWebAPIPageTemplate.md = readme\MinimalWebAPIPageTemplate.md
+		readme\HeaderTemplate.md = readme\HeaderTemplate.md
 	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Pure.DI.Templates", "src\Pure.DI.Templates\Pure.DI.Templates.csproj", "{5A925B99-3FF8-4ED0-81C2-7F0D3AD52642}"

diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
 # Pure DI for .NET
 
-_Supports .NET starting with .NET Framework 2.0, released 2005-10-27, and all newer versions._
-
 <a href="https://t.me/pure_di"><img src="https://github.com/DevTeam/Pure.DI/blob/master/readme/telegram.png" align="left" height="20" width="20" ></a>
 [![NuGet](https://buildstats.info/nuget/Pure.DI)](https://www.nuget.org/packages/Pure.DI)
 [![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
@@ -11,10 +9,12 @@ _Supports .NET starting with .NET Framework 2.0, released 2005-10-27, and all ne
 
 ![](readme/di.gif)
 
+_Supports .NET starting with .NET Framework 2.0, released 2005-10-27, and all newer versions._
+
 ## Usage requirements
 
-- Installed [.NET SDK 6.0.4](https://dotnet.microsoft.com/download/dotnet/6.0) or later
-- Using [C# 8](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-version-history#c-version-80) or later
+- .NET SDK [6.0.4](https://dotnet.microsoft.com/download/dotnet/6.0) or later is installed
+- Using [C# 8](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-version-history#c-version-80) or later version
 
 ## Key features
 

diff --git a/build/ReadmeTarget.cs b/build/ReadmeTarget.cs
@@ -14,7 +14,8 @@ internal class ReadmeTarget(
     : IInitializable, ITarget<int>
 {
     private const string ReadmeDir = "readme";
-    private const string ReadmeHeaderFile = "README.md";
+    private const string CommonReadmeFile = "README.md";
+    private const string HeaderTemplateFile = "HEaderTemplate.md";
     private const string ReadmeTemplateFile = "ReadmeTemplate.md";
     private const string FooterTemplateFile = "FooterTemplate.md";
     private const string ReadmeFile = "README.md";
@@ -43,7 +44,7 @@ internal class ReadmeTarget(
 
     public Task InitializeAsync() => commands.Register(
         this,
-        $"Generates {ReadmeHeaderFile}",
+        $"Generates {CommonReadmeFile}",
         "readme",
         "r");
 
@@ -81,8 +82,10 @@ public async Task<int> RunAsync(CancellationToken cancellationToken)
         new DotNetTest(usageTestsProjects).Run();
 
         await using var readmeWriter = File.CreateText(ReadmeFile);
+
+        await AddContent(HeaderTemplateFile, readmeWriter);
 
-        await AddContent(ReadmeHeaderFile, readmeWriter, "docs");
+        await AddContent(CommonReadmeFile, readmeWriter, "docs");
 
         await AddContent(ReadmeTemplateFile, readmeWriter);
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,9 @@
-# Pure DI for .NET
-
 _Supports .NET starting with .NET Framework 2.0, released 2005-10-27, and all newer versions._
 
-<a href="https://t.me/pure_di"><img src="https://github.com/DevTeam/Pure.DI/blob/master/readme/telegram.png" align="left" height="20" width="20" ></a>
-[![NuGet](https://buildstats.info/nuget/Pure.DI)](https://www.nuget.org/packages/Pure.DI)
-[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
-[![Build](https://teamcity.jetbrains.com/app/rest/builds/buildType:(id:OpenSourceProjects_DevTeam_PureDi_BuildAndTestBuildType)/statusIcon)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_DevTeam_PureDi_BuildAndTestBuildType&guest=1)
-[![Performance Build](https://teamcity.jetbrains.com/app/rest/builds/buildType:(id:OpenSourceProjects_DevTeam_PureDi_PerformanceTests)/statusIcon)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_DevTeam_PureDi_PerformanceTests&guest=1)
-![GitHub Build](https://github.com/DevTeam/Pure.DI/actions/workflows/main.yml/badge.svg)
-
-![](readme/di.gif)
-
 ## Usage requirements
 
-- Installed [.NET SDK 6.0.4](https://dotnet.microsoft.com/download/dotnet/6.0) or later
-- Using [C# 8](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-version-history#c-version-80) or later
+- .NET SDK [6.0.4](https://dotnet.microsoft.com/download/dotnet/6.0) or later is installed
+- Using [C# 8](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-version-history#c-version-80) or later version
 
 ## Key features
 

diff --git a/readme/HeaderTemplate.md b/readme/HeaderTemplate.md
@@ -0,0 +1,11 @@
+# Pure DI for .NET
+
+<a href="https://t.me/pure_di"><img src="https://github.com/DevTeam/Pure.DI/blob/master/readme/telegram.png" align="left" height="20" width="20" ></a>
+[![NuGet](https://buildstats.info/nuget/Pure.DI)](https://www.nuget.org/packages/Pure.DI)
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![Build](https://teamcity.jetbrains.com/app/rest/builds/buildType:(id:OpenSourceProjects_DevTeam_PureDi_BuildAndTestBuildType)/statusIcon)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_DevTeam_PureDi_BuildAndTestBuildType&guest=1)
+[![Performance Build](https://teamcity.jetbrains.com/app/rest/builds/buildType:(id:OpenSourceProjects_DevTeam_PureDi_PerformanceTests)/statusIcon)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_DevTeam_PureDi_PerformanceTests&guest=1)
+![GitHub Build](https://github.com/DevTeam/Pure.DI/actions/workflows/main.yml/badge.svg)
+
+![](readme/di.gif)
+