Skip to content

Commit

Permalink
docs: add CONTRIBUTORS
Browse files Browse the repository at this point in the history
  • Loading branch information
MHKarami97 committed Nov 25, 2024
1 parent 902cf43 commit 955f385
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributors

Thank you to all the contributors who have helped improve this project!

## List of Contributors

- [@mhkarami97](https://github.com/mhkarami97)
- [@all4ehsan](https://github.com/all4ehsan)

## How to Contribute

If you'd like to contribute to this project, feel free to fork the repository and submit a pull request!
1 change: 1 addition & 0 deletions CacheManager.sln
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution", "Solution", "{FD
.github\workflows\greetings.yml = .github\workflows\greetings.yml
.github\workflows\label.yml = .github\workflows\label.yml
.github\workflows\stale.yml = .github\workflows\stale.yml
CONTRIBUTORS.md = CONTRIBUTORS.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CacheManagerUnitTest", "CacheManagerUnitTest\CacheManagerUnitTest.csproj", "{11A397C0-ECD3-4734-B5F5-E80037190D6D}"
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ First install package:
then you can use like this:

```csharp
var easyCacheManager = new CacheBuilder<string>()
var easyCacheManager = new CacheBuilder()
.AddApi(new ApiConfig
{
Url = StaticData.Api
Expand All @@ -26,7 +26,7 @@ var easyCacheManager = new CacheBuilder<string>()
.AddMemory(new MemoryConfig())
.Build(new LockConfig());

var result = await easyCacheManager.GetAsync("My-Key");
var result = await easyCacheManager.GetAsync<string>("My-Key");
```
You can create your own provider with these interfaces:

Expand Down Expand Up @@ -60,5 +60,13 @@ Priority should be unique, you can't crate EasyCacheManager with list of provide
With `ClearCacheAsync` method you can clear specific key on all providers that implement `ICacheSourceWithClear` or `ICacheSourceWithSetAndClear`

### Set
With `SetAsync` you can manually set value to provides that that implement `ICacheSourceWithSet` or `ICacheSourceWithSetAndClear`
With `SetAsync` you can manually set value to provides that that implement `ICacheSourceWithSet` or `ICacheSourceWithSetAndClear`


## Contributors

The following contributors have made this project better:

[See the full list of contributors](./CONTRIBUTORS.md)


0 comments on commit 955f385

Please sign in to comment.