updated readmes

Cargo.lock

@@ -114,7 +114,17 @@ dependencies = [
 
 [[package]]
 name = "labirust"
-version = "0.2.1"
+version = "0.3.0"
+dependencies = [
+ "rand",
+ "termion",
+]
+
+[[package]]
+name = "labirust"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be89e6ef8c189ed1fa5acb4475a3b43c2aa835c0788fb38b11df3ddb58359f8c"
 dependencies = [
  "rand",
  "termion",
@@ -125,7 +135,7 @@ name = "labirust-cli"
 version = "0.1.0"
 dependencies = [
  "clap",
- "labirust",
+ "labirust 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]

labirust-cli/Cargo.toml

@@ -2,9 +2,11 @@
 name = "labirust-cli"
 version = "0.1.0"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+license = "MIT"
+authors = ["JOLIMAITRE Matthieu <matthieu@imagevo.fr>"]
+description = "A cli to run labirust algorithms."
+repository = "https://github.com/MajorBarnulf/labirust/"
 
 [dependencies]
-labirust = { path = "../labirust" }
-clap = { version = "3.1.18", features = ["derive"] }
+labirust = "0.3"
+clap = { version = "3.1", features = ["derive"] }

labirust-cli/README.md

@@ -0,0 +1,12 @@
+# labirust-cli
+
+## Description
+
+A cli to run labirust algorithms.
+
+## Installation
+
+```sh
+# through cargo
+cargo install labirust-cli
+```

labirust/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "labirust"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 license = "MIT"
 authors = ["JOLIMAITRE Matthieu <matthieu@imagevo.fr>"]

labirust/README.md

@@ -14,14 +14,19 @@ Hi, I am a junior rust dev (yes, how original, I know) and this is one of the sm
 
 ## Usage
 
-If you want to see what the library is capable of, you can clone this repo and run the tests to see mazes solving themselves on the terminal.
-
-for you to see anything during the execution of tests, don't forget to add these arguments:
+If you want to see what the library is capable of, you can try the CLI, either by clonning this repo and building it with cargo or by installing it through the crates.io depot.
 ```sh
--- --nocapture
+# installation
+cargo install labirust-cli
 
-# example:
-cargo test -- implementations::breath_first --nocapture
+# usage
+labirust-cli --help
 ```
 
+
 If you want to implement more resolution algorithm yourself and for some reason you think this is the right crate to provide frameworks, you can explore the crate documentation and add this crate to your project dependencies.
+```toml
+# in Cargo.toml
+[dependencies]
+labirust = "0.3"
+```