commit 2717ec0c02d323dfd247918346d42254e46f097b parent 3c95e159b0412ea946ace8ab53c40270ca5d1f9c Author: Michael Constantine Dimopoulos <mk@mcdim.xyz> Date: Wed, 22 Jun 2022 14:35:05 +0000 Added readme Diffstat:
| A | README.md | | | 30 | ++++++++++++++++++++++++++++++ |
1 file changed, 30 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,30 @@ +<img src="https://mcdim.xyz/media/passchecklogo1.png" alt="goPasscheck logo" style="height: 200px;"/> + +# goPasscheck +<p float="left"> +<img src="https://img.shields.io/badge/version-0.1-blue"/> +<img src="https://img.shields.io/badge/language-Go-lightblue"> +<img src="https://img.shields.io/badge/license-GNU%20GPLv3+-yellow"> + +How strong is your password? **goPasscheck** can be used to intelligently assess the strength of a password, taking into account multiple variables and statistics provided by `lykan`. + +## Installation +To install, run the following commands +``` +$ git clone https://github.com/MicaelDim02/gopasscheck && cd gopasscheck/src +$ sudo make install +``` +To uninstall, run the following in `gopasscheck/src`: +``` +$ sudo make uninstall +``` + +## Usage +Check a password: +``` +gopasscheck -p password +``` +Optionally, you can provide a dictionary: +``` +gopasscheck -p password -w /usr/share/dict/words +```