docs: added readme, license, version, etc

Cargo.toml

@@ -1,7 +1,16 @@
 [package]
 name = "besafe"
-version = "0.1.0"
+description = "A simple git pre-commit hook to prevent accidental publishing of .env files!"
+authors = ["PyBash <[email protected]>"]
+homepage = "https://github.com/pybash1/besafe"
+repositry = "https://github.com/pybash1/besafe"
+documentation = "https://github.com/pybash1/winnf"
+readme = "README.md"
+license = "MIT"
+version = "1.0.0"
 edition = "2021"
+keywords = ["cli", "binary", "git", "environment"]
+categories = ["command-line-utilities"]
 
 [dependencies]
 clap = { version = "4.5.4", features = ["cargo"] }

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 PyBash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,34 @@
+# besafe
+
+A simple git pre-commit hook to prevent youfrom accidentally leaking your .env files.
+
+### Dependencies
+
+- [Git](https://git-scm.com)
+
+### To install and run
+
+#### [Cargo](https://crates.io/crates/besafe):
+
+```sh
+cargo install besafe --locked
+besafe install
+```
+
+#### Scoop:
+
+```sh
+scoop install https://raw.githubusercontent.com/pybash1/besafe/main/besafe.json
+besafe install
+```
+
+### Features
+
+- Single command installation
+- Superfast(written in Rust)
+- Has default exceptions like .env.example and gitignored files
+- Only 1 dependency
+
+### OSes tested
+
+- Windows

besafe.json

@@ -0,0 +1,9 @@
+{
+  "version": "v1.0.0",
+  "description": "A simple git pre-commit hook to prevent youfrom accidentally leaking your .env files.",
+  "homepage": "https://github.com/pybash1/besafe",
+  "license": "MIT",
+  "url": "https://github.com/pybash1/besafe/releases/download/v1.0.0/besafe.exe",
+  "bin": "besafe.exe",
+  "extract_dir": "besafe"
+}