Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gizdatullin committed Oct 25, 2024
1 parent 28b6c79 commit b192f83
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,20 @@

## Как использовать

Для работы с библиотекой необходимо зарегистрировать `YandexTrackerClient` в вашем IoC-контейнере, используя сборку `Mindbox.YandexTracker.Template`.
Для работы с библиотекой необходимо зарегистрировать `YandexTrackerClient` и `YandexTrackerClientOptions` в вашем IoC-контейнере, используя сборку `Mindbox.YandexTracker.Template`.

```csharp
services.AddYandexTrackerClient(new YandexTrackerClientOptions
{
Organization = "your_organization_id",
OAuthToken = "your_private_token";
});
services.AddOptions<YandexTrackerClientOptions>().Bind(configuration.GetSection("YandexTracker"));
services.AddYandexTrackerClient();
```

Есть возможность использовать кеширование запросов к API Яндекс.Трекера для редко изменяемых, но часто используемых
данных (список статусов, типов задач, пользователей и т.д.). Для включения кэширования необходимо при регистрации клиента
в IoC указать настройки кэширования. В настройках кэширования можно задать TTl в минутах.
использовать метод `AddYandexTrackerClientCachingDecorator` и дополнительно зарегистрировать `YandexTrackerClientCachingOptions`.
В настройках кэширования можно задать TTl в минутах (2 минуты по умолчанию).

```csharp
services.AddYandexTrackerClient(new YandexTrackerClientOptions
{
Organization = "your_organization_id",
OAuthToken = "your_private_token";
},
new YandexTrackerClientCachingDecoratorOptions
{
TTL = your_ttl // 2 минуты по умолчанию
});
services.AddOptions<YandexTrackerClientOptions>().Bind(configuration.GetSection("YandexTracker"));
services.AddOptions<YandexTrackerClientCachingOptions>().Bind(configuration.GetSection("YandexTracker"));
services.AddYandexTrackerClientCachingDecorator();
```

0 comments on commit b192f83

Please sign in to comment.