Skip to content

Commit

Permalink
tweak github readme
Browse files Browse the repository at this point in the history
  • Loading branch information
phuslu committed Jan 4, 2024
1 parent 19c96d9 commit 48a5eaa
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
### Features

* Simple
- No Dependency
- Less 1000 lines of Go
- No Dependencies
- Less than 1000 lines of Go code
* Fast
- Faster than all well-known **LRU** caches
- Zero memory allocs
- Faster than all well-known *LRU* caches
- Zero memory allocations
* GC friendly
- Pointerless data structs
- Continuous memory layout
* Memory efficient
- Uses only 24 extra bytes per cache object
- Adds only 24 extra bytes per cache object.
- TTL (2 x 4 bytes) + ArrayList node (2 x 4 bytes) + Key hash (4 bytes) + Hash Entry index (4 bytes)

### Getting Started
Expand Down Expand Up @@ -43,7 +43,7 @@ func main() {
}
```

New a LRU loading cache. https://go.dev/play/p/S261F8ij2BL
Create a loading cache. https://go.dev/play/p/S261F8ij2BL
```go
package main

Expand Down Expand Up @@ -92,7 +92,7 @@ func main() {

### Benchmarks

A Performance result as below. Check [actions][actions] for more results and details.
A Performance result as below. Check github [actions][actions] for more results and details.
<details>
<summary>benchmark on keysize=16, cachesize=1000000, parallelism=32 with read (90%) / write(10%)</summary>

Expand Down Expand Up @@ -288,8 +288,14 @@ PASS
ok command-line-arguments 46.827s
```

### License
LRU is licensed under the MIT License. See the LICENSE file for details.

### Contact
For inquiries or support, contact phus.lu@gmail.com or raise github issues.

[godoc-img]: http://img.shields.io/badge/godoc-reference-blue.svg
[godoc]: https://godoc.org/github.com/phuslu/lru
[godoc]: https://pkg.go.dev/github.com/phuslu/lru
[release-img]: https://img.shields.io/github/v/tag/phuslu/lru?label=release
[release]: https://github.com/phuslu/lru/releases
[goreport-img]: https://goreportcard.com/badge/github.com/phuslu/lru
Expand Down

0 comments on commit 48a5eaa

Please sign in to comment.