Update/add examples in readme, pack readme.md into package (#45)

IntelliTect · Sep 6, 2022 · 6c3ca32 · 6c3ca32
1 parent db2a440
commit 6c3ca32
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 9 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -13,6 +13,7 @@
   	<!-- Build symbol package (.snupkg) to distribute the PDB containing Source Link -->
   	<IncludeSymbols>true</IncludeSymbols>
   	<SymbolPackageFormat>snupkg</SymbolPackageFormat>
+	<PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
   <PropertyGroup>
   	<LangVersion>10.0</LangVersion>
@@ -23,6 +24,7 @@
   	<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
   </PropertyGroup>
   <ItemGroup>
+	<None Include="../README.md" Pack="true" PackagePath="\"/>
   	<SourceRoot Include="$(MSBuildThisFileDirectory)"/>
   	<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
   	  <PrivateAssets>all</PrivateAssets>

diff --git a/IntelliTect.Multitool/RepositoryPaths.cs b/IntelliTect.Multitool/RepositoryPaths.cs
@@ -1,13 +1,13 @@
-namespace IntelliTect.Multitool;
+namespace IntelliTect.Multitool;
 /// <summary>
-/// Provides normalized paths.
+/// Provides consistent environment-independent normalized pathing within a repository.
 /// </summary>
 public static class RepositoryPaths
 {
     /// <summary>
     /// Finds the root of the repository by looking for the .git folder.
     /// </summary>
-    /// <returns>Full path to repo root</returns>
+    /// <returns>Full path to repo root.</returns>
     public static string GetDefaultRepoRoot()
     {
         DirectoryInfo? currentDirectory = new(Directory.GetCurrentDirectory());

diff --git a/README.md b/README.md
@@ -2,13 +2,31 @@
 
 ## Namespaces within this library
 
-* IntelliTect.Multitool
-  * AssemblyInfo: Gets an assembly's linker date/time as shown in [IntelliTect's Blog](https://intellitect.com/blog/displaying-deploymentbuild-date-web-pages/)
-* IntelliTect.Multitool.Security
-  * ClaimsPrincipalExtensions: Extention methods to get a user ID and roles.
+-------
+
+### IntelliTect.Multitool
+
+* AssemblyInfo: Gets an assembly's linker date/time as shown in [IntelliTect's Blog](https://intellitect.com/blog/displaying-deploymentbuild-date-web-pages/).
+  * Example Usage:
+
+  ```csharp
+  // This example is in cshtml
+  @(AssemblyInfo.Date.ToString("yyyy-MM-dd HH-mm"))
+  ```
+
+* RepositoryPaths: Provides consistent environment-independent normalized pathing within a repository.
+  * Example Usage:
+
+  ```csharp
+  string fullPathToTheFile = Path.Combine(RepositoryPaths.GetDefaultRepoRoot(), "TheFile.txt");
+  ```
+
+### IntelliTect.Multitool.Security
+
+* ClaimsPrincipalExtensions: Extention methods to get a user ID and roles.
 
 ## Contributing
 
-------------
+-------
 
-See the CONTRIBUTING.md file [here](https://raw.githubusercontent.com/IntelliTect/Multitool/main/CONTRIBUTING.md).
+See the CONTRIBUTING.md file [here](https://github.com/IntelliTect/Multitool/blob/main/CONTRIBUTING.md).