Skip to content

Commit

Permalink
Added part of the Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
kubagdynia committed Dec 18, 2023
1 parent 8ef870a commit ac7083c
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
```
<PackageReference Include="CacheDrive" Version="0.1.1" />
```

### 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).

0 comments on commit ac7083c

Please sign in to comment.