diff --git a/README.md b/README.md index 04f0e12..5786dbb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # T-Digest -A map-reduce and parallel streaming friendly data-structure for accurate +A fast map-reduce and parallel streaming friendly data-structure for accurate quantile approximation. -This package provides a very crude implementation of Ted Dunning's t-digest -data structure in Go. +This package provides an implementation of Ted Dunning's t-digest data +structure in Go. [![Build Status](https://travis-ci.org/caio/go-tdigest.svg?branch=master)](https://travis-ci.org/caio/go-tdigest) [![GoDoc](https://godoc.org/github.com/caio/go-tdigest?status.svg)](http://godoc.org/github.com/caio/go-tdigest) [![Go Report Card](https://goreportcard.com/badge/github.com/caio/go-tdigest)](https://goreportcard.com/report/github.com/caio/go-tdigest) +## Project Status + +This project is activelly maintained. There hasn't been a need for new features +or bugs in a while, so there isn't much activity but I'm more than willing to +cooperate on bugs and/or requests. + ## Installation The current stable version can be installed via: @@ -45,18 +51,11 @@ func main() { } ``` -## Disclaimer - -I've written this solely with the purpose of understanding how the -data-structure works, it hasn't been throughly verified nor battle tested -in a production environment. - ## References -This is a very simple port of the [reference][1] implementation with some -ideas borrowed from the [python version][2]. If you wanna get a quick grasp of -how it works and why it's useful, [this video and companion article is pretty -helpful][3]. +This is a port of the [reference][1] implementation with some ideas borrowed +from the [python version][2]. If you wanna get a quick grasp of how it works +and why it's useful, [this video and companion article is pretty helpful][3]. [1]: https://github.com/tdunning/t-digest [2]: https://github.com/CamDavidsonPilon/tdigest