update readme

itsdfish · Sep 17, 2023 · fc4c42a · fc4c42a
1 parent 172584e
commit fc4c42a
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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. 
+See the [documentation](https://itsdfish.github.io/RankChoiceVoting.jl/dev/) for more information and examples.