From 4e1304cff49508ee9ecbd470ba241cf24f94eb6a Mon Sep 17 00:00:00 2001
From: Oleg Kovalov <oleg@hey.com>
Date: Tue, 23 Aug 2022 18:59:07 +0200
Subject: [PATCH] Update README

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index efe6189..aafa979 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
 # perp
-Go per P cache 
+
+[![build-img]][build-url]
+[![pkg-img]][pkg-url]
+[![reportcard-img]][reportcard-url]
+[![coverage-img]][coverage-url]
+[![version-img]][version-url]
+
+Go per processor.
+
+## Rationale
+
+TODO
+
+## Features
+
+* Simple API.
+* Clean and tested code.
+* Optimized for speed.
+* Concurrent-safe.
+* Dependency-free.
+
+See [GUIDE.md](https://github.com/go-perf/perp/blob/main/GUIDE.md) for more details.
+
+## Install
+
+Go version 1.17+
+
+```
+go get github.com/go-perf/perp
+```
+
+## Example
+
+```go
+```
+
+Also see examples: [example_test.go](https://github.com/go-perf/perp/blob/main/example_test.go).
+
+## Documentation
+
+See [these docs][pkg-url].
+
+## License
+
+[MIT License](LICENSE).
+
+[build-img]: https://github.com/go-perf/perp/workflows/build/badge.svg
+[build-url]: https://github.com/go-perf/perp/actions
+[pkg-img]: https://pkg.go.dev/badge/go-perf/perp/v4
+[pkg-url]: https://pkg.go.dev/github.com/go-perf/perp/v4
+[reportcard-img]: https://goreportcard.com/badge/go-perf/perp
+[reportcard-url]: https://goreportcard.com/report/go-perf/perp
+[coverage-img]: https://codecov.io/gh/go-perf/perp/branch/main/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/go-perf/perp
+[version-img]: https://img.shields.io/github/v/release/go-perf/perp
+[version-url]: https://github.com/go-perf/perp/releases