diff --git a/README.md b/README.md index e4a0729..d042a0a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # PowerKit -Collection of utilities and extensions for rapid .NET development + +[![Status](https://img.shields.io/badge/status-active-47c219.svg)](https://github.com/Tyrrrz/.github/blob/prime/docs/project-status.md) +[![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://tyrrrz.me/ukraine) +[![Build](https://img.shields.io/github/actions/workflow/status/Tyrrrz/PowerKit/main.yml?branch=prime)](https://github.com/Tyrrrz/PowerKit/actions) +[![Coverage](https://img.shields.io/codecov/c/github/Tyrrrz/PowerKit/prime)](https://codecov.io/gh/Tyrrrz/PowerKit) +[![Version](https://img.shields.io/nuget/v/PowerKit.svg)](https://nuget.org/packages/PowerKit) +[![Downloads](https://img.shields.io/nuget/dt/PowerKit.svg)](https://nuget.org/packages/PowerKit) +[![Discord](https://img.shields.io/discord/869237470565392384?label=discord)](https://discord.gg/2SUWKFnHSm) +[![Fuck Russia](https://img.shields.io/badge/fuck-russia-e4181c.svg?labelColor=000000)](https://twitter.com/tyrrrz/status/1495972128977571848) + + + + + +
Development of this project is entirely funded by the community. Consider donating to support!
+ +**PowerKit** is a collection of utilities and extensions for rapid .NET development. +It's distributed as a source-only package that can be referenced without imposing any run-time dependencies. + +## Terms of use[[?]](https://github.com/Tyrrrz/.github/blob/prime/docs/why-so-political.md) + +By using this project or its source code, for any purpose and in any shape or form, you grant your **implicit agreement** to all the following statements: + +- You **condemn Russia and its military aggression against Ukraine** +- You **recognize that Russia is an occupant that unlawfully invaded a sovereign state** +- You **support Ukraine's territorial integrity, including its claims over temporarily occupied territories of Crimea and Donbas** +- You **reject false narratives perpetuated by Russian state propaganda** + +To learn more about the war and how you can help, [click here](https://tyrrrz.me/ukraine). Glory to Ukraine! πŸ‡ΊπŸ‡¦ + +## Install + +- πŸ“¦ [NuGet](https://nuget.org/packages/PowerKit): `dotnet add package PowerKit` + +> [!WARNING] +> To use this package, your project needs to target C# 14 or later. +> You can ensure this by using the latest .NET SDK and setting `latest` in the project file. + +> [!IMPORTANT] +> The library is statically tested for compatibility with .NET Standard 2.0+ and .NET Framework 3.5+, however some of the older targets may require additionally installing [**PolyShim**](https://github.com/Tyrrrz/PolyShim).