From 7218a17d11223db0b3770d52a745e747a0b3f0ba Mon Sep 17 00:00:00 2001 From: thinker227 Date: Wed, 10 Jan 2024 19:55:39 +0100 Subject: [PATCH] Add package readme --- src/Rascal/Rascal.csproj | 4 ++-- src/Rascal/package-readme.md | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 src/Rascal/package-readme.md diff --git a/src/Rascal/Rascal.csproj b/src/Rascal/Rascal.csproj index 6293443..c40e86e 100644 --- a/src/Rascal/Rascal.csproj +++ b/src/Rascal/Rascal.csproj @@ -24,7 +24,7 @@ thinker227 thinker227 2023 LICENSE.txt - README.md + package-readme.md true https://github.com/thinker227/Rascal git @@ -32,7 +32,7 @@ - + diff --git a/src/Rascal/package-readme.md b/src/Rascal/package-readme.md new file mode 100644 index 0000000..7badc63 --- /dev/null +++ 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.