syncthing/vendor/github.com/stathat/go/README.md
Jakob Borg 65aaa607ab Use Go 1.5 vendoring instead of Godeps
Change made by:

- running "gvt fetch" on each of the packages mentioned in
  Godeps/Godeps.json
- `rm -rf Godeps`
- tweaking the build scripts to not mention Godeps
- tweaking the build scripts to test `./lib/...`, `./cmd/...` explicitly
  (to avoid testing vendor)
- tweaking the build scripts to not juggle GOPATH for Godeps and instead
  set GO15VENDOREXPERIMENT.

This also results in some updated packages at the same time I bet.

Building with Go 1.3 and 1.4 still *works* but won't use our vendored
dependencies - the user needs to have the actual packages in their
GOPATH then, which they'll get with a normal "go get". Building with Go
1.6+ will get our vendored dependencies by default even when not using
our build script, which is nice.

By doing this we gain some freedom in that we can pick and choose
manually what to include in vendor, as it's not based on just dependency
analysis of our own code. This is also a risk as we might pick up
dependencies we are unaware of, as the build may work locally with those
packages present in GOPATH. On the other hand the build server will
detect this as it has no packages in it's GOPATH beyond what is included
in the repo.

Recommended tool to manage dependencies is github.com/FiloSottile/gvt.
2016-03-05 21:21:24 +01:00

68 lines
1.6 KiB
Markdown

stathat
=======
This is a Go package for posting stats to your StatHat account.
For more information about StatHat, visit [www.stathat.com](http://www.stathat.com).
Installation
------------
Use `go get`:
go get github.com/stathat/go
That's it.
Import it like this:
import (
"github.com/stathat/go"
)
Usage
-----
The easiest way to use the package is with the EZ API functions. You can add stats
directly in your code by just adding a call with a new stat name. Once StatHat
receives the call, a new stat will be created for you.
To post a count of 1 to a stat:
stathat.PostEZCountOne("messages sent - female to male", "something@stathat.com")
To specify the count:
stathat.PostEZCount("messages sent - male to male", "something@stathat.com", 37)
To post a value:
stathat.PostEZValue("ws0 load average", "something@stathat.com", 0.372)
There are also functions for the classic API. The drawback to the classic API is
that you need to create the stats using the web interface and copy the keys it
gives you into your code.
To post a count of 1 to a stat using the classic API:
stathat.PostCountOne("statkey", "userkey")
To specify the count:
stathat.PostCount("statkey", "userkey", 37)
To post a value:
stathat.PostValue("statkey", "userkey", 0.372)
Contact us
----------
We'd love to hear from you if you are using this in your projects! Please drop us a
line: [@stat_hat](http://twitter.com/stat_hat) or [contact us here](http://www.stathat.com/docs/contact).
About
-----
Written by Patrick Crosby at [StatHat](http://www.stathat.com). Twitter: [@stat_hat](http://twitter.com/stat_hat)