Skip to content

Commit

Permalink
Update Readme (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
rodaine authored Jul 6, 2017
1 parent 04b5328 commit 04fc2f0
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
# Gostats
# Gostats [![GoDoc](https://godoc.org/github.com/lyft/gostats?status.svg)](https://godoc.org/github.com/lyft/gostats) [![Build Status](https://travis-ci.org/lyft/gostats.svg?branch=master)](https://travis-ci.org/lyft/gostats)

## Overview

Gostats is a Golang statistics library with support for Counters, Gauges, and Timers.
For full documentation visit [gostats' go doc](https://godoc.org/github.com/lyft/gostats).
`gostats` is a Go metrics library with support for Counters, Gauges, and Timers.

## Installation

```
```sh
go get github.com/lyft/gostats
```

## Building
## Building & Testing

```
make bootstrap && make compile-test
```sh
make install
make test
```

## Usage

In order to start using gostats, import it to your project with:
In order to start using `gostats`, import it into your project with:

```Go
```go
import "github.com/lyft/gostats"
```

0 comments on commit 04fc2f0

Please sign in to comment.