diff --git a/README.md b/README.md index 780ecd8..9b5e294 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# psudohash \ No newline at end of file +# psudohash +[![Python 3.x](https://img.shields.io/badge/python-3.x-yellow.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-MIT-red.svg)](https://github.com/t3l3machus/psudohash/blob/main/LICENSE) + + +## Purpose + +## Screenshot +![usage_example_png](https://raw.github.com/t3l3machus/psudohash/master/Screenshots/psudohash.png) + +## Installation +No special requirements. Just clone the repo and make the script executable: +``` +git clone https://github.com/t3l3machus/psudohash +cd ./psudohash +chmod +x psudohash.py +``` +## Usage +``` +./psudohash.py [-h] -w WORDS [-an LEVEL] [-nl LIMIT] [-y YEARS] [-ap VALUES] [-cpb] [-cpa] [-cpo] [-o FILENAME] [-q] +``` +The help dialog [ -h, --help ] includes usage details and examples. +## Usage Tips + +## Future +I'm gathering information regarding commonly used password creation patterns to enhance the tool's capabilities.