info

Cargo.toml

@@ -1,15 +1,15 @@
 [package]
-name = "template"
+name = "wordle-analyzer"
 version = "0.1.0"
 edition = "2021"
 publish = false
 authors = ["Christoph J. Scherr <software@cscherr.de>"]
 license = "MIT"
-description = "No description yet"
+description = "Play, Analyze and Benchmark Wordle  / Wordle Strategies"
 readme = "README.md"
-homepage = "https://git.cscherr.de/PlexSheep/rs-base"
-repository = "https://git.cscherr.de/PlexSheep/rs-base"
-keywords = ["template"]
+homepage = "https://git.cscherr.de/PlexSheep/wordle-analyzer"
+repository = "https://git.cscherr.de/PlexSheep/wordle-analyzer"
+keywords = ["wordle", "benchmark"]
 
 
 [dependencies]

README.md

@@ -1,3 +1,17 @@
-# rs-base
+# Wordle-analyzer
 
-Base repository for rust projects
+[Wordle](https://en.wikipedia.org/wiki/Wordle) is a popular game in which you
+have to guess words by slowly guessing the letters contained in it.
+
+`Wordle-analyzer` aims to offer a few things:
+
+* A basic implementation of the Wordle game
+* An Interface for solvers for the Wordle game, which can make use of math and
+  information theory
+* A benchmark for Wordle solvers
+
+## Wordlists
+
+Included in this repository are the following wordlists:
+
+* [`./data/wordlists/en_dwyl_words.txt`](https://github.com/dwyl/english-words)