Add docs and linters before release (#6)

* Add a lint target to Makefile

* Add a README

* Add a simple example

* Add a PR template

* Show off usable zero values
This commit is contained in:
Akshay Shah
2016-05-29 20:50:32 -07:00
parent 2051a605b9
commit 68f9c8c0d0
6 changed files with 119 additions and 2 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# atomic [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov]
Simple numeric wrappers to enforce atomic access.
## Installation
`go get -u github.com/uber-go/atomic`
## Usage
The standard library's `sync/atomic` is powerful, but it's easy to forget which
variables must be accessed atomically. `uber-go/atomic` preserves all the
functionality of the standard library, but wraps the primitive numeric types to
provide a safer, more convenient API.
```go
var atom atomic.Uint32
atom.Store(42)
atom.Sub(2)
atom.CAS(40, 11)
```
See the [documentation][doc] for a complete API specification.
## Development Status
Stable.
<hr>
Released under the [MIT License](LICENSE.txt).
[doc-img]: https://godoc.org/github.com/uber-go/atomic?status.svg
[doc]: https://godoc.org/github.com/uber-go/atomic
[ci-img]: https://travis-ci.org/uber-go/atomic.svg?branch=master
[ci]: https://travis-ci.org/uber-go/atomic
[cov-img]: https://coveralls.io/repos/github/uber-go/atomic/badge.svg?branch=master
[cov]: https://coveralls.io/github/uber-go/atomic?branch=master