From af5d5e4d25ad87b38a327d38cca68ea2f41c2f8c Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Tue, 22 Sep 2020 18:15:49 +0100 Subject: [PATCH 1/3] [add] Updated Readme with the proper badges, documentation link, and install instructions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index db35ebf..e79e6d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ hdrhistogram-go =============== +PkgGoDev +[![Gitter](https://badges.gitter.im/Join_Chat.svg)](https://gitter.im/HdrHistogram/HdrHistogram) +![Test](https://github.com/HdrHistogram/hdrhistogram-go/workflows/Test/badge.svg?branch=master) + [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/HdrHistogram/hdrhistogram-go/blob/master/LICENSE) + A pure Go implementation of the [HDR Histogram](https://github.com/HdrHistogram/HdrHistogram). From 85dd313f1c06ab0abe8065412bd8c0c25be871b9 Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Tue, 22 Sep 2020 18:25:04 +0100 Subject: [PATCH 2/3] [add] Made reference to issue and fix on documentation --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e79e6d4..7a7e62e 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,60 @@ A pure Go implementation of the [HDR Histogram](https://github.com/HdrHistogram/ For documentation, check [godoc](http://godoc.org/github.com/codahale/hdrhistogram). -Repo transfer and impact on go dependencies + +## Getting Started + +### Installing +Use `go get` to retrieve the hdrhistogram-go implementation and to add it to your `GOPATH` workspace, or project's Go module dependencies. + +```go +go get github.com/HdrHistogram/hdrhistogram-go +``` + +To update the implementation use `go get -u` to retrieve the latest version of the hdrhistogram. + +```go +go get github.com/HdrHistogram/hdrhistogram-go +``` + + +### Go Modules + +If you are using Go modules, your `go get` will default to the latest tagged +release version of the histogram. To get a specific release version, use +`@` in your `go get` command. + +```go +go get github.com/HdrHistogram/hdrhistogram-go@v0.9.0 +``` + +To get the latest HdrHistogram/hdrhistogram-go master repository change use `@latest`. + +```go +go get github.com/HdrHistogram/hdrhistogram-go@latest +``` + +### Repo transfer and impact on go dependencies ------------------------------------------- This repository has been transferred under the github HdrHstogram umbrella with the help from the orginal author in Sept 2020. The main reasons are to group all implementations under the same roof and to provide more active contribution from the community as the orginal repository was archived several years ago. + Unfortunately such URL change will break go applications that depend on this library -directly or indirectly. +directly or indirectly, as discussed [here](https://github.com/HdrHistogram/hdrhistogram-go/issues/30#issuecomment-696365251). + The dependency URL should be modified to point to the new repository URL. The tag "v0.9.0" was applied at the point of transfer and will reflect the exact code that was frozen in the original repository. -Credits +If you are using Go modules, you can update to the exact point of transfter using the `@v0.9.0` tag in your `go get` command. + +``` +go mod edit -replace github.com/codahale/hdrhistogram=github.com/HdrHistogram/hdrhistogram-go@v0.9.0 +``` + +## Credits ------- Many thanks for Coda Hale for contributing the initial implementation and transfering the repository here. + From ee9c55661ec29e74344dd78a8d87441b96509050 Mon Sep 17 00:00:00 2001 From: filipecosta90 Date: Tue, 22 Sep 2020 19:28:28 +0100 Subject: [PATCH 3/3] [fix] Fixes per PR review. Updated doc links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a7e62e..83c998e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ A pure Go implementation of the [HDR Histogram](https://github.com/HdrHistogram/ > behavior across the value range and the subsequent value resolution at any > given level. -For documentation, check [godoc](http://godoc.org/github.com/codahale/hdrhistogram). +For documentation, check [godoc](https://pkg.go.dev/github.com/HdrHistogram/hdrhistogram-go). ## Getting Started