diff --git a/.gitignore b/.gitignore
index a983205..8625c9b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,3 +11,10 @@ obj/
# Backup files
*.bak
+
+# Docs
+docfx/_site/**
+docfx/netstandard2.0/**
+docfx/net6.0/**
+docfx/net7.0/**
+docfx/net8.0/**
diff --git a/README.md b/README.md
index 52e3fdf..32aa21d 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,9 @@ of an operation, whether it's successful or has encountered an error, in a more
structured manner. This project is heavily inspired by [Michael Altmann](https://github.com/altmann)'s
excellent work with [FluentResults](https://github.com/altmann/FluentResults).
+[![main](https://img.shields.io/github/actions/workflow/status/jscarle/LightResults/main.yml?logo=github)](https://github.com/jscarle/LightResults)
[![nuget](https://img.shields.io/nuget/v/LightResults)](https://www.nuget.org/packages/LightResults)
-[![main](https://github.com/jscarle/LightResults/actions/workflows/main.yml/badge.svg)](https://github.com/jscarle/LightResults)
+[![downloads](https://img.shields.io/nuget/dt/LightResults)](https://www.nuget.org/packages/LightResults)
## References
@@ -29,7 +30,11 @@ This library has no dependencies.
- ๐งช Native โ Written, compiled, and tested against the latest versions of .NET.
- โค๏ธ Compatible โ Available for dozens of versions of .NET as a [.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0) library.
- ๐ช Trimmable โ Compatible with [ahead-of-time compilation](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/) (AOT) as of .NET 7.0.
-- ๐ Performant โ Heavily optimized and benchmarked to aim for the highest possible performance.
+- ๐ Performant โ Heavily optimized and [benchmarked](https://jscarle.github.io/LightResults/docs/performance.html) to aim for the highest possible performance.
+
+## Documentation
+
+Make sure to [read the docs](https://jscarle.github.io/LightResults/) for the full API.
## Getting Started
diff --git a/docfx/docfx.json b/docfx/docfx.json
index 4ac88cd..7c809bd 100644
--- a/docfx/docfx.json
+++ b/docfx/docfx.json
@@ -85,7 +85,7 @@
"_appTitle": "LightResults",
"_appLogoPath": "images/Logo.png",
"_appFaviconPath": "images/Icon.png",
- "_appFooter": "Developed and maintained by Jean-Sebastien Carle โ jscarle.dev",
+ "_appFooter": "Developed and maintained by Jean-Sebastien Carle โ jscarle.dev\r\n",
"_enableSearch": true
}
}
diff --git a/docfx/index.md b/docfx/index.md
index ae8091d..705638c 100644
--- a/docfx/index.md
+++ b/docfx/index.md
@@ -4,14 +4,19 @@ _layout: landing
# LightResults - Operation Result Patterns for .NET
+Star
+Issue
+Sponsor
+
LightResults is an extremely light and modern .NET library that provides a simple and flexible
implementation of the Result Pattern. The Result Pattern is a way of representing the outcome
of an operation, whether it's successful or has encountered an error, in a more explicit and
structured manner. This project is heavily inspired by [Michael Altmann](https://github.com/altmann)'s
excellent work with [FluentResults](https://github.com/altmann/FluentResults).
+[![main](https://img.shields.io/github/actions/workflow/status/jscarle/LightResults/main.yml?logo=github)](https://github.com/jscarle/LightResults)
[![nuget](https://img.shields.io/nuget/v/LightResults)](https://www.nuget.org/packages/LightResults)
-[![main](https://github.com/jscarle/LightResults/actions/workflows/main.yml/badge.svg)](https://github.com/jscarle/LightResults)
+[![downloads](https://img.shields.io/nuget/dt/LightResults)](https://www.nuget.org/packages/LightResults)
## References
@@ -31,4 +36,4 @@ This library has no dependencies.
- ๐งช Native โ Written, compiled, and tested against the latest versions of .NET.
- โค๏ธ Compatible โ Available for dozens of versions of .NET as a [.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0) library.
- ๐ช Trimmable โ Compatible with [ahead-of-time compilation](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/) (AOT) as of .NET 7.0.
-- ๐ Performant โ Heavily optimized and benchmarked to aim for the highest possible performance.
+- ๐ Performant โ Heavily optimized and [benchmarked](https://jscarle.github.io/LightResults/docs/performance.html) to aim for the highest possible performance.