docs: Add README.md

.drone.yml

@@ -0,0 +1,15 @@
+kind: pipeline
+type: docker
+name: default
+
+steps:
+  - name: publish
+    image: rust:slim
+    commands:
+      - /usr/bin/env cargo publish
+    environment:
+      CARGO_REGISTRY_TOKEN:
+        from_secret: cargo_token
+trigger:
+  event:
+    - tag

Cargo.lock

@@ -66,7 +66,9 @@ dependencies = [
 
 [[package]]
 name = "dental-notation"
-version = "0.1.0"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a3c00b2dc40e4c58d6bce550f3c415454be6fbc4b79024918cb40931828c88fb"
 dependencies = [
  "owo-colors",
 ]

Cargo.toml

@@ -2,10 +2,11 @@
 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"]
 
 [dependencies]
 clap = {version = "3.2.5", features = [ "derive" ] }
-dental-notation = { path = ".." }
+dental-notation = "1.0.0"

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