From 4e80e99910c2756136f8993943e60b1be3772f9d Mon Sep 17 00:00:00 2001
From: ztimson <zaktimson@gmail.com>
Date: Thu, 14 Dec 2023 20:02:07 -0500
Subject: [PATCH] Updated readme

---
 README.md        | 78 +++++++++++++++++++++++++++++++++++++++++-------
 password_hash.py |  2 +-
 2 files changed, 68 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 45bbd3e..965a701 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,47 @@
-# password_hasher
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/941ba5e37b669fb4ca722ec226b10b9206c2d65006641d0dd77d6a122ee64aff" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+  ### Password Hasher
+
+  <!-- Description -->
+  Python Password Hasher
+
+  <!-- Repo badges -->
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/password-hasher/tags&query=$[0].name)](https://git.zakscode.com/ztimson/password-hasher/tags)
+  [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/password-hasher&query=open_pr_counter)](https://git.zakscode.com/ztimson/password-hasher/pulls)
+  [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/password-hasher&query=open_issues_count)](https://git.zakscode.com/ztimson/password-hasher/issues)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://git.zakscode.com/ztimson/password-hasher/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/password-hasher/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/password-hasher/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [Password Hasher](#top)
+    - [About](#about)
+        - [Built With](#built-with)
+    - [Setup](#setup)
+        - [Production](#production)
+    - [License](#license)
+
+## About
+
 Python utility to hash passwords. Often when creating a user, a hashed password is needed. This cammond line utility can simply hash the password or multiple parameters can be passed to replicated. password, salt, hashing algorithm, pass+salt concatination order, and number of iterations can all be specified.
 
-### Authors
- * [Zak Timson](http://zakscode.com)
-
-### License
-GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007. read LICENSE for more
-
-### API
 ```
-Usage: password_hash.py [options] PASSWORD
+Usage: password_hash.py [OPTIONS] <PASSWORD>
 
 Options:
   -h, --help            show this help message and exit
@@ -22,5 +54,29 @@ Options:
   --hash-algorithms     display available hash algorithms and exit
 ```
 
-### Bug Reporting
-Please submit bugs to the github [issue tracker](https://github.com/zaktimson/password_hasher/issues)
+
+### Built With
+[![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python)](https://www.python.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="production" style="display: inline">
+    Production
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Python](https://www.python.org/downloads/)
+
+#### Instructions
+1. Download script: `curl https://git.zakscode.com/ztimson/password-hasher/raw/branch/master/password_hash.py`
+2. Run python script: `python3 password_hasher.py [OPTIONS] <PASSWORD>`
+
+</details>
+
+## License
+Copyright © 2007 Zakary Timson | Available under the GNU General Public License
+
+See the [license](./LICENSE) for more information.
diff --git a/password_hash.py b/password_hash.py
index f20eca0..1e7cd41 100644
--- a/password_hash.py
+++ b/password_hash.py
@@ -72,7 +72,7 @@ def output(password, salt, iterations, hash_algorithm):
 
 
 # Specify flags
-parser = OptionParser(usage="usage: %prog [options] PASSWORD")
+parser = OptionParser(usage="usage: %prog [OPTIONS] <PASSWORD>")
 parser.add_option("-s", "--salt", help="specify salt")
 parser.add_option("-i", "--iterations", help="specify number of iterations to hash password")
 parser.add_option("-o", "--order", help="order the password and salt ex. \"ps\" to append salt")