diff --git a/README.md b/README.md index 790c3c2..9e3c692 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# CacheDrive [![NuGet Version](https://img.shields.io/nuget/v/CacheDrive.svg?style=flat)](https://www.nuget.org/packages/CacheDrive/) +# CacheDrive + +[![CI](https://img.shields.io/github/actions/workflow/status/kubagdynia/CacheDrive/dotnet.yml?branch=main)](https://github.com/kubagdynia/CacheDrive/actions?query=branch%3Amain) [![NuGet Version](https://img.shields.io/nuget/v/CacheDrive.svg?style=flat)](https://www.nuget.org/packages/CacheDrive/) + Simple in-memory caching provider with the ability to store objects in files. + +### Project structure +- CacheDrive - CacheDrive library +- CacheDrive.ExampleConsoleApp - console application with example use of the Cache Drive library +- CacheDrive.Tests - unit tests + +### Installation +Use NuGet Package Manager +``` +Install-Package CacheDrive +``` +or .NET CLI +``` +dotnet add package CacheDrive +``` + +or just copy into the project file to reference the package +``` + +``` + +### How to use + + + +### Technologies +List of technologies, frameworks and libraries used for implementation: +- [.NET 7.0 or .NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) (platform) +- [NUnit](https://nunit.org/) (testing framework) + +### License +This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).