Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
JimChenWYU committed Aug 23, 2024
1 parent eabaeed commit 784e4ac
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Badge]][build status]
[![Benchmark Badge]][benchmark status]
[![Go Reference]][godoc]
[![Codecov Badge]][coverage status]
[![License Badge]][license]

Expand Down Expand Up @@ -60,8 +61,20 @@ func main() {
}
```

## Documentation

See the [API documentation on go.dev][godoc]

## Thanks

- [jeromefroe/lru-rs][LRU Cache implementation in a Rust crate]
- [hashicorp/golang-lru](https://github.com/hashicorp/golang-lru)


[build badge]: https://github.com/lovelysunlight/lru-go/actions/workflows/ci.yaml/badge.svg
[benchmark badge]: https://github.com/lovelysunlight/lru-go/actions/workflows/benchmark.yaml/badge.svg
[godoc]: https://pkg.go.dev/github.com/lovelysunlight/lru-go?tab=doc
[go reference]: https://pkg.go.dev/badge/github.com/lovelysunlight/lru-go?status.svg
[build status]: https://github.com/lovelysunlight/lru-go/actions/workflows/ci.yaml
[codecov badge]: https://codecov.io/gh/lovelysunlight/lru-go/branch/master/graph/badge.svg
[coverage status]: https://codecov.io/gh/lovelysunlight/lru-go
Expand Down

0 comments on commit 784e4ac

Please sign in to comment.