docs: Add README.md

2022-09-02 22:56:51 +02:00 · 2022-09-02 22:56:51 +02:00 · 4475713a80
commit 4475713a80
parent 5e340a4402
2 changed files with 8 additions and 0 deletions
--- a/Cargo.toml
+++ b/Cargo.toml
@ -2,6 +2,7 @@
 name = "dental-notation-cli"
 version = "0.1.0"
 edition = "2021"
+description = "Command-line tool used to parse and display tooth numbers"
 repository = "https://git.barthes.xyz/guilhem/dental-notation-cli"
 license = "GPL-3.0-or-later"
 categories = ["parsing", "command-line-utilities"]
--- a/README.md
+++ b/README.md
@ -0,0 +1,7 @@
+# Dental notation CLI
+
+Small CLI tool used to operate on [dental-notation crate](https://crates.io/crates/dental-notation). The following features are for now available:
+
+- Display a mouth in different notations
+- Show a specific tooth in this mouth
+- Convert between the different notations