From 4475713a8095de1a15838005be269f36bb72d008 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilhem=20Barth=C3=A9s?= Date: Fri, 2 Sep 2022 22:56:51 +0200 Subject: [PATCH] docs: Add README.md --- Cargo.toml | 1 + README.md | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 2ae982f..016b001 100644 --- 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"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef147f2 --- /dev/null +++ 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