Skip to content

Commit

Permalink
add info about key's limit
Browse files Browse the repository at this point in the history
  • Loading branch information
umputun committed Jan 24, 2019
1 parent dfa9c5d commit feb2435
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

The library adds a thin layer on top of [lru cache](https://github.com/hashicorp/golang-lru) and [patrickmn/go-cache](https://github.com/patrickmn/go-cache).

| Cache name | Constructor | Defaults | Description |
| ---------------- | ----------------------- | ----------------- | --------------------- |
| `LruCache` | `lcw.NewLruCache` | keys=1000 | LRU cache with limits |
| `ExpirableCache` | `lcw.NewExpirableCache` | keys=1000, ttl=5m | TTL cache with limits |
| `Nop` | `lcw.NewNopCache` | | Do-nothing cache |
| Cache name | Constructor | Defaults | Description |
| -------------- | --------------------- | ----------------- | --------------------- |
| LruCache | lcw.NewLruCache | keys=1000 | LRU cache with limits |
| ExpirableCache | lcw.NewExpirableCache | keys=1000, ttl=5m | TTL cache with limits |
| Nop | lcw.NewNopCache | | Do-nothing cache |


Main features:
Expand All @@ -16,6 +16,7 @@ Main features:
- Limit maximum cache size (in bytes)
- Limit maximum key size
- Limit maximum size of a value
- Limit number of keys
- TTL support (`ExpirableCache` only)
- Functional style invalidation
- Functional options
Expand Down

0 comments on commit feb2435

Please sign in to comment.