Merge pull request #29 from essentialkaos/develop

Improved readme, Makefile and TravisCI config

.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 language: go
 
 go:
-  - 1.6.x
-  - 1.7.x
   - 1.8.x
+  - 1.9.x
+  - 1.10.x
   - tip
 
 branches:

Makefile

@@ -1,23 +1,31 @@
-########################################################################################
+################################################################################
 
-# This Makefile generated by GoMakeGen 0.6.0 using next command:
+# This Makefile generated by GoMakeGen 0.8.0 using next command:
 # gomakegen --metalinter .
 
-########################################################################################
+################################################################################
 
-.PHONY = fmt deps metalinter
+.DEFAULT_GOAL := help
+.PHONY = fmt deps metalinter help
 
-########################################################################################
+################################################################################
 
-deps:
+deps: ## Download dependencies
 	git config --global http.https://pkg.re.followRedirects true
 	go get -d -v pkg.re/essentialkaos/ek.v9
+	go get -d -v pkg.re/essentialkaos/librato.v7
 
-fmt:
+fmt: ## Format source code with gofmt
 	find . -name "*.go" -exec gofmt -s -w {} \;
 
-metalinter:
+metalinter: ## Install and run gometalinter
 	test -s $(GOPATH)/bin/gometalinter || (go get -u github.com/alecthomas/gometalinter ; $(GOPATH)/bin/gometalinter --install)
 	$(GOPATH)/bin/gometalinter --deadline 30s
 
-########################################################################################
+help: ## Show this info
+	@echo -e '\nSupported targets:\n'
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[33m%-12s\033[0m %s\n", $$1, $$2}'
+	@echo -e ''
+
+################################################################################

README.md

@@ -0,0 +1,46 @@
+<p align="center"><a href="#readme"><img src="https://gh.kaos.st/go-librato.svg"/></a></p>
+
+<p align="center"><a href="#installation">Installation</a> • <a href="#examples">Examples</a> • <a href="#license">License</a></p>
+
+<p align="center">
+  <a href="https://godoc.org/pkg.re/essentialkaos/librato.v7"><img src="https://godoc.org/pkg.re/essentialkaos/librato.v7?status.svg"></a>
+  <a href="https://travis-ci.org/essentialkaos/librato"><img src="https://travis-ci.org/essentialkaos/librato.svg"></a>
+  <a href="https://goreportcard.com/report/github.com/essentialkaos/librato"><img src="https://goreportcard.com/badge/github.com/essentialkaos/librato"></a>
+  <a href="https://codebeat.co/projects/github-com-essentialkaos-librato"><img alt="codebeat badge" src="https://codebeat.co/badges/f82e704d-67a7-4c6f-9e5d-1acf058c937b" /></a>
+  <a href="https://essentialkaos.com/ekol"><img src="https://gh.kaos.st/ekol.svg"></a>
+</p>
+
+Package for working with [Librato Metrics](https://www.librato.com) API from Go code.
+
+### Installation
+
+Before the initial install allows git to use redirects for [pkg.re](https://github.com/essentialkaos/pkgre) service (_reason why you should do this described [here](https://github.com/essentialkaos/pkgre#git-support)_):
+
+```
+git config --global http.https://pkg.re.followRedirects true
+```
+
+Make sure you have a working Go 1.8+ workspace (_[instructions](https://golang.org/doc/install)_), then
+
+```
+go get pkg.re/essentialkaos/librato.v7
+```
+
+For update to latest stable release, do:
+
+```
+go get -u pkg.re/essentialkaos/librato.v7
+```
+
+### Examples
+
+* [Basic Usage](examples/basic_example.go)
+* [Metrics Collector](examples/collector_example.go)
+* [Async Sending](examples/async_example.go)
+* [Annotations](examples/annotations_example.go)
+
+### License
+
+[EKOL](https://essentialkaos.com/ekol)
+
+<p align="center"><a href="https://essentialkaos.com"><img src="https://gh.kaos.st/ekgh.svg"/></a></p>

librato.go

@@ -3,7 +3,7 @@ package librato
 
 // ////////////////////////////////////////////////////////////////////////////////// //
 //                                                                                    //
-//                     Copyright (c) 2009-2017 ESSENTIAL KAOS                         //
+//                     Copyright (c) 2009-2018 ESSENTIAL KAOS                         //
 //        Essential Kaos Open Source License <https://essentialkaos.com/ekol>         //
 //                                                                                    //
 // ////////////////////////////////////////////////////////////////////////////////// //