From fc4c42a63d72aea370393518e7380807cd308765 Mon Sep 17 00:00:00 2001 From: itsdfish Date: Sun, 17 Sep 2023 13:21:56 -0400 Subject: [PATCH] update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 70c828e..1abfd63 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# RankChoiceVoting.jl (Work in progress) +# RankChoiceVoting.jl [![](docs/logo/logo.png)](https://itsdfish.github.io/RankChoiceVoting.jl/dev/) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://itsdfish.github.io/RankChoiceVoting.jl/dev/) [![CI](https://github.com/itsdfish/RankChoiceVoting.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/itsdfish/RankChoiceVoting.jl/actions/workflows/CI.yml) -This package provides a framework for simulating and evaluating rank choice voting systems. +This package provides a framework for simulating and evaluating rank choice voting systems. See the [documentation](https://itsdfish.github.io/RankChoiceVoting.jl/dev/) for details. # Quick Example @@ -34,4 +34,4 @@ satisfies(system, criterion, rankings) ``` false ``` -See the documentation for more information. \ No newline at end of file +See the [documentation](https://itsdfish.github.io/RankChoiceVoting.jl/dev/) for more information and examples. \ No newline at end of file