diff --git a/README.md b/README.md index 349b252..03d4dc1 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,22 @@ -*This is a reimplementation and reimagination of my other project [euchre-cli](https://https://github.com/boldandbrad/meeple-cli).* +> [!WARNING]
+> **euchre-tui** is currently in **ALPHA**. This means it is highly unstable and +> is missing key features. # euchre-tui [![Crates.io](https://img.shields.io/crates/v/euchre-tui)](https://crates.io/crates/euchre-tui) -**euchre-tui** allows you to play euchre in your terminal with a beautifully +Play euchre in your terminal with a beautifully designed text-based interface. -...but what the heck is even euchre? - -Euchre is a team-based trick-taking card game for 4 players that is popular in -the US Midwest, and some other places. - -> [!WARNING]
-> **euchre-tui** is currently in **ALPHA**. This means it is highly unstable and -> is missing key features. - **Jump to:** [Demo](#demo) | [Features](#features) | [Installation](#install) | [Getting Started](#getting-started) | [Configuration](#config) | -[Legal](#legal) | +[FAQ](#faq) | +[Legal](#legal) ## 📼 Demo @@ -51,14 +45,23 @@ cargo install euchre-tui ## 🚀 Getting started - -> Coming soon. + +```bash +euchre +``` ## ⚙️ Configuration > Coming soon. +## ❓ FAQ + +### ...but what the heck is even euchre? + +Euchre is a team-based trick-taking card game for 4 players that is popular in +the US Midwest, and some other places. + ## ⚖️ Legal Copyright (c) 2024 Bradley Wojcik. Released under the MIT License. See