Skip to content

Commit

Permalink
Merge pull request #19 from openhistogram/LicUpd
Browse files Browse the repository at this point in the history
upd: readme and license for go docs
  • Loading branch information
maier authored Mar 23, 2021
2 parents 840ab2f + e845642 commit f61134e
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 31 deletions.
28 changes: 27 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
OpenHistogram OR BSD-3-Clause
Copyright (c) 2012-2021, Circonus, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name Circonus, Inc. nor the names of its contributors
may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 changes: 0 additions & 27 deletions LICENSE.BSD-3-Clause

This file was deleted.

15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# circonusllhist

A golang implementation of the OpenHistogram [libcircllhist](https://github.com/openhistogram/libcircllhist) library.

[![Go Reference](https://pkg.go.dev/badge/github.com/openhistogram/circonusllhist.svg)](https://pkg.go.dev/github.com/openhistogram/circonusllhist)

## Overview
Package `circllhist` provides an implementation of OpenHistogram's fixed log-linear histogram data structure. This allows tracking
of histograms in a composable way such that accurate error can be reasoned about.

More complete docs can be found at https://pkg.go.dev/github.com/circonus-labs/circonusllhist
Package `circllhist` provides an implementation of OpenHistogram's fixed log-linear histogram data structure. This allows tracking of histograms in a composable way such that accurate error can be reasoned about.

## License

[OpenHistogram](LICENSE.OpenHistogram) OR [BSD-3-Clause](LICENSE)

## Documentation

More complete docs can be found at [pkg.go.dev](https://pkg.go.dev/github.com/openhistogram/circonusllhist)

0 comments on commit f61134e

Please sign in to comment.