From 00abbce3d1874f5dc868f72d7ab464f8e3772468 Mon Sep 17 00:00:00 2001 From: Jakub Kurlowicz Date: Thu, 21 Dec 2023 20:54:47 +0100 Subject: [PATCH] Readme file updated --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 4dc962a..05cd26c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -24,6 +28,8 @@ or just copy into the project file to reference the package ``` + + ### How to use - Register a CacheDrive library, e.g. @@ -102,6 +108,8 @@ public class App } } ``` + + ### ICacheService API Explanation ```csharp @@ -208,6 +216,8 @@ public interface ICacheService } ``` + + ### Configuration ```csharp @@ -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)