Akshay Shah 68f9c8c0d0 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
2016-05-29 20:50:32 -07:00
2016-05-25 11:04:20 -07:00
2016-05-25 11:04:20 -07:00
2016-05-28 22:54:33 -07:00
2016-05-25 11:04:20 -07:00
2016-05-25 11:04:20 -07:00

atomic GoDoc Build Status Coverage Status

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.

var atom atomic.Uint32
atom.Store(42)
atom.Sub(2)
atom.CAS(40, 11)

See the documentation for a complete API specification.

Development Status

Stable.


Released under the [MIT License](LICENSE.txt).
Description
atomic [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Go Report Card][reportcard-img]][reportcard]
Readme 235 KiB
Languages
Go 97.9%
Makefile 2.1%