Add package readme

thinker227 · Jan 10, 2024 · 7218a17 · 7218a17
1 parent 385d399
commit 7218a17
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/Rascal/Rascal.csproj b/src/Rascal/Rascal.csproj
@@ -24,15 +24,15 @@
     <Authors>thinker227</Authors>
     <Copyright>thinker227 2023</Copyright>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageReadmeFile>package-readme.md</PackageReadmeFile>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <RepositoryUrl>https://github.com/thinker227/Rascal</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
   <!-- Include additional files -->
   <ItemGroup>
-    <None Include="../../README.md" Pack="true" PackagePath="/" />
+    <None Include="./package-readme.md" Pack="true" PackagePath="/" />
     <None Include="../../LICENSE.txt" Pack="true" PackagePath="/" />
     <None Include="../../CHANGELOG.md" Pack="true" PackagePath="/"/>
   </ItemGroup>

diff --git a/src/Rascal/package-readme.md b/src/Rascal/package-readme.md
@@ -0,0 +1,5 @@
+Rascal is a simple yet powerful [result type](https://www.youtube.com/watch?v=srQt1NAHYC0&t=1018s) implementation for C#, containing a variety of utilities and standard functions for working with result types and integrating them into the rest of C#.
+
+Rascal is first and foremost an aggregate of the result types I personally find myself implementing in a majority of my own projects, and a competetor other result libraries second. As such, this library implements some things I think other result implementations are lacking, while omitting some features other libraries do implement.
+
+**TODO**: Link to the Github Pages docfx documentation.