Skip to content

Commit

Permalink
Readme file updated
Browse files Browse the repository at this point in the history
  • Loading branch information
kubagdynia committed Dec 21, 2023
1 parent cf035b4 commit 00abbce
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@
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
Expand All @@ -24,6 +28,8 @@ or just copy into the project file to reference the package
<PackageReference Include="CacheDrive" Version="0.1.1" />
```



### How to use

- Register a CacheDrive library, e.g.
Expand Down Expand Up @@ -102,6 +108,8 @@ public class App
}
}
```


### ICacheService API Explanation

```csharp
Expand Down Expand Up @@ -208,6 +216,8 @@ public interface ICacheService
}
```



### Configuration

```csharp
Expand Down Expand Up @@ -260,6 +270,17 @@ public class CacheSettings
```



### Code Examples

- CacheDrive.ExampleConsoleApp
https://github.com/kubagdynia/CacheDrive/tree/main/CacheDrive.ExampleConsoleApp
- IpGeolocation
https://github.com/kubagdynia/IpGeolocation/blob/main/IpGeolocation/Services/IpGeolocationService.cs




### 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)
Expand Down

0 comments on commit 00abbce

Please sign in to comment.