diff --git a/README.md b/README.md index 8083bb0..9b5dae8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,129 @@ -# SimpleToolkit.Extensions +

+

SimpleToolkit.Extensions

+ +

Set of helpers, class extensions, UI controls used in my other C# projects

+ +

SimpleToolkit is package of useful classes, helpers, extensions and UI controls, I use in my C# projects. Extensions subpackage contains classes extensions.

+ +--- + +## NuGet registry status + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Subpackage + + Status +
+ SimpleToolkit.Extensions + + +
+ Other subpackages +
+ SimpleToolkit.Attributes + + +
+ SimpleToolkit.MVVM + + +
+ SimpleToolkit.UI.Models + + +
+ SimpleToolkit.UI.WinUI.Behaviors + + +
+ SimpleToolkit.UI.WinUI.Converters + + +
+ SimpleToolkit.UI.WinUI.Controls + + +
+ SimpleToolkit.UI.WinUI.Helpers + + +
+ +## Features + +- **StringExtensions** + - *(static)* **CreateRandom** - returns random string + - **Shuffle** - returns shuffled string +- **HttpClientExtensions** + - **DownloadAsync** - allows to track progress of downloading data +- **StreamExtensions** + - **CopyToAsync** - allows to track progress of copying data +- **IEnumerableExtensions** + - **Random** - returns random item from IEnumerable + +## Installation and usage + +You can download package from official NuGet registry or .nupkg file itself from Releases tab. + +**CLI:** + +``` +dotnet add package SimpleToolkit.Extensions +``` + +**Package reference in .csproj file:** + +``` + +``` + +## Attribution and contribution + +This project is open source on MIT License, so you can just copy and upload again to your repository. But according to the license, you must include information about the original author. You can find license here. + +However, the preferred way to contribute would be to propose improvements in a pull request, through issues, or through other means of communication. + +**Other sources:** + +- Icon by Icons8 \ No newline at end of file