v1.0.0

Cargo.toml

@@ -1,9 +1,15 @@
 [package]
-name = "git-aware"
-version = "0.1.0"
+name = "gitaware"
+version = "1.0.0"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+authors = ["Paul Rosset <[email protected]>"]
+license = "MIT"
+description = "Git Aware is a **command line tool** that aims to make it easier to detect any dirty working copy in projects that uses Git"
+readme = "README.md"
+homepage = "https://github.com/PaulRosset/git-aware"
+repository = "https://github.com/PaulRosset/git-aware"
+keywords = ["cli", "git", "git-status", "status", "detection"]
+categories = ["command-line-utilities"]
 
 [dependencies]
 git2 = "0.15.0"

README.md

@@ -0,0 +1,32 @@
+# git-aware
+
+Git Aware is a **command line tool** that aims to make it easier to detect any dirty working copy in projects that uses Git.
+
+## Why ?
+
+Git Aware has been designed to address the need when an person will drop or switch of computer but want to make sure that we will not lose on any Git related content.
+
+The CLI tool will scan and identify all the Git repositories on your system and notify you if your working copy is dirty, allowing you to take timely action and prevent the loss of any previous work.
+
+## Usage
+
+To use it, there is multiples possibilities:
+
+- You can either download the binary for MAC [here]()
+- If you are not on a MAC you can serve the binary yourself by running `cargo build --release` at the root of the repository, the binary will be served under `target/release/gitaware`
+
+Once the binary is located on your machine, to use it simply do:
+
+- `gitaware`
+
+or if you want to target a directory:
+
+- `gitaware -p the/directory/to/target`
+
+## Results
+
+![A sample result from the CLI tool](./public/sample-git-aware.png)
+
+## Contribute
+
+Any contribution are welcome.