diff --git a/README.md b/README.md new file mode 100644 index 0000000..e707dbb --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Wordle + +This is a clone of Wordle which is played in your terminal! + +The same wordlist is used in this project so you get the same words each +day as if you played on the official website. + +![Screenshot](./screenshot.png) + +This is built using [Bubble Tea](https://github.com/charmbracelet/bubbletea) +and [Lip Gloss](https://github.com/charmbracelet/lipgloss). + +## Features + +- [x] Statistics are saved to `~/.wordle.json` for use in other programs. +- [x] Same word list as the official website. +- [ ] Leaderboard of people on current tilde +- [ ] Export to sharable message/emojis +- [ ] Share to Mastodon +- [ ] Play previous days + +## Usage + +Simply download one of the binaries from the [release page](https://tildegit.org/jakew/wordle/releases), +then run it to get started. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..8dc3b40 Binary files /dev/null and b/screenshot.png differ