Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cristaloleg committed Aug 23, 2022
1 parent 9b6805a commit 4e1304c
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 4e1304c

Please sign in to comment.