<h1 align="center">
Tecken
</h1>
<p align="center">
<em>A typing practice tool in the terminal.</em>
</p>
<p align="center">
<img src="https://img.shields.io/crates/v/tecken?style=flat-square&color=blueviolet&link=https%3A%2F%2Fcrates.io%2Fcrates%tecken" alt="Crates.io version" />
<img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="MIT License" />
<img src="https://img.shields.io/github/last-commit/simon-danielsson/tecken/main?style=flat-square&color=blue" alt="Last commit" />
</p>
<p align="center">
<a href="#info">Info</a> •
<a href="#install">Install</a> •
<a href="#usage">Usage</a> •
<a href="#license">License</a>
</p>
<p align="center">
<img src="media/1.gif" alt="screenshot">
</p>
---
<div id="info"></div>
## 📌 Information
Tecken is a minimal typing practice game for the terminal. Built using [crossterm](https://github.com/crossterm-rs/crossterm)
---
<div id="install"></div>
## 📦 Install
``` bash
cargo install tecken
```
---
<div id="usage"></div>
## 💻 Usage
``` terminal
Subcommands
help : print help
Flags
-w <int> : set amount of words for exercise (default: 12)
-e : endless mode (statistics after program exit will be disabled)
-h : hide metadata in ui
Controls
[Esc] : quit
[Ctrl-C] : quit
```
---
<div id="license"></div>
## 📜 License
This project is licensed under the [MIT License](https://github.com/simon-danielsson/tecken/blob/main/LICENSE).