Merge pull request #5 from prometheus/documentation/community/api-reference

Include link to generated API documentation.
This commit is contained in:
juliusv 2013-03-28 02:53:56 -07:00
commit 6c08aa2e95
1 changed files with 7 additions and 1 deletions

View File

@ -66,6 +66,12 @@ representation thereof. For instance, if a values therein is requested,
it may situationally emit a minimum, maximum, an average, or any other it may situationally emit a minimum, maximum, an average, or any other
reduction mechanism requested. reduction mechanism requested.
# Getting Started
* The source code is periodically indexed: [Go Exposition Client](http://godoc.org/github.com/prometheus/client_golang).
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
# Testing # Testing
This package employs [gocheck](http://labix.org/gocheck) for testing. Please This package employs [gocheck](http://labix.org/gocheck) for testing. Please
ensure that all tests pass by running the following from the project root: ensure that all tests pass by running the following from the project root:
@ -73,4 +79,4 @@ ensure that all tests pass by running the following from the project root:
$ go test ./... $ go test ./...
The use of gocheck is summarily being phased out; however, old tests that use it The use of gocheck is summarily being phased out; however, old tests that use it
still exist. still exist.