Skip to content

Commit

Permalink
Update README with project status
Browse files Browse the repository at this point in the history
  • Loading branch information
caio committed Feb 16, 2017
1 parent 1804f1c commit d604b3c
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d604b3c

Please sign in to comment.