From 6a0fe5a5847b96b462e7cd815f7442f15eb0bc1e Mon Sep 17 00:00:00 2001 From: serr Date: Mon, 6 Jan 2025 01:13:25 +0300 Subject: [PATCH] readme md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 85c7e67..489056c 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,31 @@ ## Установка -Для использования CandyCache в вашем проекте, установить его, используя **go get git.hikan.ru/serr/candycache** +Для использования CandyCache в вашем проекте, установите его, используя **go get git.hikan.ru/serr/candycache**, далее просто добавьте в блок импорта. ## Основные возможности - **Автоматика**: автоматическая очистка устаревших элементов и возможность ее отключения - **Возможность ручного управления** - **Безопасность**: конкурентный доступ к данным возможен благодаря мьютексам -- **Гибкость**: кэш может хранить любые типы данных \ No newline at end of file +- **Гибкость**: кэш может хранить любые типы данных + +## Использование + +# Создание кэша + +Для создания нового экземпляра кэша используйте функцию **Cacher**, передавая интервал очистки в наносекундах: +```cache := candycache.Cacher(10 * time.Minute) // Очистка каждые 10 минут``` + +# Добавление элемента + +Для добавления элемента в кэш используйте метод **Add**: +```cache.Add("key", "value", 5 * time.Minute) // Элемент будет храниться 5 минут``` +В случае, если по указанном ключу уже что-то хранится, оно будет заменено на новый элемент. + +# Получение элемента + +Для получения элемента из кэша используйте метод **Get**: + +```value, found := cache.Get("key") // Получение значения по ключу "key"``` +Если элемент найден, то в переменную **value** будет записано значение, а в **found** — **true**. Если элемент не найден, то в **found** будет записано **false**, а значением вернется **nil** \ No newline at end of file