Updated docs.

.gitignore

@@ -11,3 +11,10 @@ obj/
 
 # Backup files
 *.bak
+
+# Docs
+docfx/_site/**
+docfx/netstandard2.0/**
+docfx/net6.0/**
+docfx/net7.0/**
+docfx/net8.0/**

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
 

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 — <a href=\"https://jscarle.dev\">jscarle.dev</a>",
+      "_appFooter": "Developed and maintained by Jean-Sebastien Carle — <a href=\"https://jscarle.dev\">jscarle.dev</a><script async defer src=\"https://buttons.github.io/buttons.js\"></script><script async src=\"https://www.googletagmanager.com/gtag/js?id=G-ERKQEFDJYX\"></script>\r\n<script>\r\n  window.dataLayer = window.dataLayer || [];\r\n  function gtag(){dataLayer.push(arguments);}\r\n  gtag('js', new Date());\r\n\r\n  gtag('config', 'G-ERKQEFDJYX');\r\n</script>",
       "_enableSearch": true
     }
   }

docfx/index.md

@@ -4,14 +4,19 @@ _layout: landing
 
 # LightResults - Operation Result Patterns for .NET
 
+<a class="github-button" href="https://github.com/jscarle/LightResults" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="octicon-star" data-size="large" aria-label="Star LightResults on GitHub">Star</a>
+<a class="github-button" href="https://github.com/jscarle/LightResults/issues" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="octicon-issue-opened" data-size="large" aria-label="Open issue for LightResults on GitHub">Issue</a>
+<a class="github-button" href="https://github.com/sponsors/jscarle" data-color-scheme="no-preference: light; light: light; dark: dark;" data-icon="octicon-heart" data-size="large" aria-label="Sponsor @jscarle on GitHub">Sponsor</a>
+
 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.