From ecb69f84ab1bf78042331cd9942b10d6d1f3321e Mon Sep 17 00:00:00 2001 From: domi41 Date: Wed, 7 Jul 2021 17:02:55 +0200 Subject: [PATCH] docs --- README.md | 6 +++++- tally.go | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 812a54f..2a72039 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ Supports billions of judgments and thousands of proposals per poll, if need be. ## Installation +> NOT AVAILABLE YET + go get -u github.com/mieuxvoter/judgment @@ -90,6 +92,8 @@ func main() { ## Contribute -A review by a seasoned `Go` veteran would be appreciated. +This project needs a review by `Go` devs. +Feel free to suggest changes, report issues, make improvements, etc. +Some more information is available in [`docs/`](./docs). diff --git a/tally.go b/tally.go index 6a0f745..4f949dc 100644 --- a/tally.go +++ b/tally.go @@ -82,6 +82,7 @@ func (proposalTally *ProposalTally) FillWithStaticDefault(upToAmount uint64, def return nil } +// Mutates the proposalTally func (proposalTally *ProposalTally) FillWithMedianDefault(upToAmount uint64) (err error) { analysis := proposalTally.Analyze()