From 12852d54672c0f654d4c020a601adef81d72fadb Mon Sep 17 00:00:00 2001 From: domi41 Date: Wed, 12 May 2021 02:13:27 +0200 Subject: [PATCH] docs: fill up the README --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c6c1cf8..08a2921 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Majority Judgment Library for Java [![MIT](https://img.shields.io/github/license/MieuxVoter/majority-judgment-library-java)](./LICENSE.md) -![Build Status](https://img.shields.io/github/workflow/status/MieuxVoter/majority-judgment-library-java/Java%20CI%20with%20Maven) -![Release](https://img.shields.io/github/v/release/MieuxVoter/majority-judgment-library-java?sort=semver) +[![Build Status](https://img.shields.io/github/workflow/status/MieuxVoter/majority-judgment-library-java/Java%20CI%20with%20Maven)](https://github.com/MieuxVoter/majority-judgment-library-java/actions) +[![Release](https://img.shields.io/github/v/release/MieuxVoter/majority-judgment-library-java?sort=semver)](https://github.com/MieuxVoter/majority-judgment-library-java/releases) [![Join the Discord chat at https://discord.gg/rAAQG9S](https://img.shields.io/discord/705322981102190593.svg)](https://discord.gg/rAAQG9S) Test-driven java library to help deliberate using Majority Judgment. @@ -11,6 +11,15 @@ The goal is to be **scalable**, **reliable**, fast and extensible. We therefore use a _score-based algorithm_ and _no floating-point arithmetic_ whatsoever. +## Features + +- Supports billions of participants +- Supports thousands of proposals +- Handles default grades (static or normalized) +- No floating-point arithmetic +- Room for other deliberators (central, usual) + + ## Example Usage Collect the **tallies** for each Proposal (aka. Candidate) by your own means, @@ -48,6 +57,8 @@ Got even more than that ? Use `BigInteger`s ! Want to set a static default grade ? Use a `TallyWithDefaultGrade` instead of a `Tally`. +Want to normalize the tallies ? Use a `TallyNormalized` instead of a `Tally`. + ## Roadmap @@ -60,8 +71,8 @@ Want to set a static default grade ? Use a `TallyWithDefaultGrade` instead of a - [ ] Guess the amount of judges - [ ] Allow defining a default grade - [x] Static Grade (configurable) + - [x] Normalization (using least common multiple) - [ ] Median Grade - - [ ] Normalization (using least common multiple) - [ ] Release v0.2.0 - [ ] Publish on package repositories - [ ] Gradle