From 5ec429b2a054a882cfcf36feae854f6b5b666169 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 10 Jun 2018 02:16:29 +0300 Subject: [PATCH 1/3] Improved readme, Makefile and TravisCI config --- .travis.yml | 4 ++-- changelog.md => CHANGELOG.md | 0 Makefile | 26 +++++++++++++------- README.md | 46 ++++++++++++++++++++++++++++++++++++ librato.go | 2 +- readme.md | 36 ---------------------------- 6 files changed, 66 insertions(+), 48 deletions(-) rename changelog.md => CHANGELOG.md (100%) create mode 100644 README.md delete mode 100644 readme.md diff --git a/.travis.yml b/.travis.yml index 54b8ff2..5b32771 100644 --- a/.travis.yml +++ b/.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: diff --git a/changelog.md b/CHANGELOG.md similarity index 100% rename from changelog.md rename to CHANGELOG.md diff --git a/Makefile b/Makefile index 791acdb..73dbaf4 100644 --- a/Makefile +++ b/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 '' + +################################################################################ diff --git a/README.md b/README.md new file mode 100644 index 0000000..68b6942 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +

+ +

Installation • Examples • License

+ +

+ + + + codebeat badge + +

+ +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) + +

diff --git a/librato.go b/librato.go index 8c35cc4..7081687 100644 --- a/librato.go +++ b/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 // // // // ////////////////////////////////////////////////////////////////////////////////// // diff --git a/readme.md b/readme.md deleted file mode 100644 index 87e54ba..0000000 --- a/readme.md +++ /dev/null @@ -1,36 +0,0 @@ -# Librato [![GoDoc](https://godoc.org/pkg.re/essentialkaos/librato.v7?status.svg)](https://godoc.org/pkg.re/essentialkaos/librato.v7) [![Build Status](https://travis-ci.org/essentialkaos/librato.svg?branch=master)](https://travis-ci.org/essentialkaos/librato) [![Go Report Card](https://goreportcard.com/badge/github.com/essentialkaos/librato)](https://goreportcard.com/report/github.com/essentialkaos/librato) [![codebeat badge](https://codebeat.co/badges/f82e704d-67a7-4c6f-9e5d-1acf058c937b)](https://codebeat.co/projects/github-com-essentialkaos-librato) [![License](https://gh.kaos.io/ekol.svg)](https://essentialkaos.com/ekol) - -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.6+ 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) - -

From 238fb4f1b47383f492a707f8f8df29d4fdf5b510 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 10 Jun 2018 02:17:28 +0300 Subject: [PATCH 2/3] Improved readme, Makefile and TravisCI config --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 68b6942..56799ba 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

+

Installation • Examples • License

From ea1c5222cf363138efabeaf9a1c9f575f350c7bc Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 10 Jun 2018 02:18:15 +0300 Subject: [PATCH 3/3] Improved readme, Makefile and TravisCI config --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 56799ba..fad5220 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ Package for working with [Librato Metrics](https://www.librato.com) API from Go ### 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)): +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 +Make sure you have a working Go 1.8+ workspace (_[instructions](https://golang.org/doc/install)_), then ``` go get pkg.re/essentialkaos/librato.v7