Mention TTL in README

This commit is contained in:
Alexandre Archambault 2016-09-01 14:01:18 +02:00
parent 6cf415cf8a
commit 37a45e4932
No known key found for this signature in database
GPG Key ID: 14640A6839C263A9
2 changed files with 25 additions and 0 deletions

View File

@ -545,6 +545,15 @@ We're using the `Cache.file` method, that can also be given a `Logger` (for more
## Extra features
### TTL
Changing things in cache are given a time-to-live (TTL) of **24 hours** by default. Changing things are artifacts for versions ending with `-SNAPSHOT`, Maven metadata files listing available versions, etc.
The most straightforward way of changing that consists in setting `COURSIER_TTL` in the environment. It's parsed with `scala.concurrent.duration.Duration`, so that things like `24 hours`, `5 min`, `10s`, or `0s`, are fine, and it accepts infinity (`Inf`) as a duration.
### Printing trees
E.g. to print the dependency tree of `io.circe:circe-core:0.4.1`,

View File

@ -572,6 +572,22 @@ We're using the `Cache.file` method, that can also be given a `Logger` (for more
## Extra features
### TTL
Changing things in cache are given a time-to-live (TTL) of **24 hours** by default. Changing things are artifacts for versions ending with `-SNAPSHOT`, Maven metadata files listing available versions, etc.
The most straightforward way of changing that consists in setting `COURSIER_TTL` in the environment. It's parsed with `scala.concurrent.duration.Duration`, so that things like `24 hours`, `5 min`, `10s`, or `0s`, are fine, and it accepts infinity (`Inf`) as a duration.
```tut:invisible
import scala.concurrent.duration.Duration
Duration("24 hours")
Duration("5 min")
Duration("10s")
Duration("0s")
Duration("Inf")
```
### Printing trees
E.g. to print the dependency tree of `io.circe:circe-core:0.4.1`,