chore(password-generator): 🚀 v1.1.3

README.md

@@ -1,11 +1,20 @@
-# Password Generator
+<!-- markdownlint-disable MD033 MD041 -->
+
+<img
+  src="https://kura.pro/password-generator-pro/images/logos/password-generator-pro.webp"
+  alt="Password Generator Logo"
+  width="261"
+  align="right"
+/>
 
-![Banner representing the Password Generator](https://raw.githubusercontent.com/sebastienrousseau/password-generator/master/assets/password-generator-logo.svg)
+<!-- markdownlint-enable MD033 MD041 -->
+
+# Password Generator
 
-A fast, simple and powerful open-source utility tool for generating strong, unique and random passwords. Password Generator is free to use as a secure password generator on any computer, phone, or tablet.
+A fast, simple, and powerful open-source utility tool for generating strong, unique, and random passwords. The Password Generator supports various types of passwords including base64-encoded, memorable, and complex strong passwords. It is designed to be a versatile tool for both personal and enterprise needs, ensuring that all users have access to high-security password options. Password Generator is free to use as a secure password generator on any computer, phone, or tablet.
 
-[![Getting Started](https://raw.githubusercontent.com/sebastienrousseau/password-generator/master/assets/button-primary.svg)](#installation)
-[![Download the Password Generator Tool v1.1.1](https://raw.githubusercontent.com/sebastienrousseau/password-generator/master/assets/button-secondary.svg)](https://github.com/sebastienrousseau/password-generator/archive/refs/tags/1.1.1.zip)
+[![Getting Started](https://kura.pro/common/images/buttons/button-primary.svg)](#installation)
+[![Download the Password Generator Tool v1.1.3](https://kura.pro/common/images/buttons/button-secondary.svg)](https://github.com/sebastienrousseau/password-generator/archive/refs/tags/1.1.3.zip)
 
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0acb169c95e443729551979e0fd86eaf)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=sebastienrousseau/password-generator&utm_campaign=Badge_Grade)
 [![npm](https://img.shields.io/npm/v/@sebastienrousseau/password-generator.svg?style=flat&color=success)](https://www.npmjs.com/package/@sebastienrousseau/password-generator)
@@ -14,6 +23,15 @@ A fast, simple and powerful open-source utility tool for generating strong, uniq
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg?style=flat)](https://opensource.org/licenses/MIT)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsebastienrousseau%2Fpassword-generator.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsebastienrousseau%2Fpassword-generator?ref=badge_small)
 
+## Features
+
+-   **Base64 Passwords**: Generate passwords with base64 encoding for a balance of security and usability.
+-   **Memorable Passwords**: Create passwords using a combination of memorable words, making them easier to remember while maintaining security.
+-   **Strong Passwords**: Produce highly secure passwords with customizable length and complexity to meet the highest security standards.
+-   **Customizable Options**: Specify password length, complexity, and word separators to tailor your password to your security needs.
+-   **CLI Support**: Use the Password Generator directly from your terminal for quick and easy access.
+-   **Secure**: Built with security as a priority, using cryptographic functions to ensure password strength.
+
 ## Installation
 
 ### From NPM or YARN
@@ -27,7 +45,7 @@ To install the Password Generator Tool, use either npm or yarn as follows:
 
 Clone the main repository to get all source files including build scripts: `git clone https://github.com/sebastienrousseau/password-generator.git`
 
-## ❓ What's included
+## What's included
 
 Within the download you'll find all the password generator source files grouped into the _dist_ folder.
 
@@ -98,7 +116,9 @@ You'll see something like this:
 9 directories, 50 files
 ```
 
-## 💿 Usage
+## Usage
+
+To generate a password, you can call the Password Generator with the desired type and options. Below are examples of how to generate each type of password:
 
 ### From the CLI
 
@@ -134,7 +154,7 @@ var generatePassword = require('password-generator');
 <script src="<https://raw.githubusercontent.com/sebastienrousseau/password-generator/master/src/bin/password-generator.js>" type="text/javascript"></script>
 ```
 
-## 🔐 Password options
+## Password options
 
 ### Base64 password
 
@@ -196,15 +216,15 @@ node . -t memorable -i 4 -s -
 node dist/src/lib/memorable-password.js -t base64  -i 4 -s -
 ```
 
-## 🚥 Semantic Versioning Policy
+## Semantic Versioning Policy
 
 For transparency into our release cycle and in striving to maintain backward compatibility, `password-generator` follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
 
-## ✅ Changelog
+## Changelog
 
 -   [GitHub Releases](https://github.com/sebastienrousseau/password-generator/releases)
 
-## ❤️ Contributing
+## Contributing
 
 Please read carefully through our [Contributing Guidelines](https://github.com/sebastienrousseau/password-generator/blob/master/.github/CONTRIBUTING.md) for further details on the process for submitting pull requests to us.
 
@@ -217,21 +237,21 @@ Development Tools
 -   `yarn lint-fix` instructs ESLint to try to fix as many issues as possible..
 -   `yarn test` runs tests and measures coverage.
 
-## 📖 Rules
+## Rules
 
 We are committed to preserving and fostering a diverse, welcoming community. Please read our [Code of Conduct](https://github.com/sebastienrousseau/password-generator/blob/master/.github/CODE-OF-CONDUCT.md).
 
-## ⭐️ Our Values
+## Our Values
 
 -   We believe perfection must consider everything.
 -   We take our passion beyond code into our daily practices.
 -   We are just obsessed about creating and delivering exceptional solutions.
 
-## ⚖️ License
+## License
 
 This project is licensed under the MIT License - see the [LICENSE](https://github.com/sebastienrousseau/password-generator/blob/master/LICENSE) file for details
 
-## 🏢 Acknowledgements
+## Acknowledgements
 
 [The Password Generator Tool](https://password-generator.pro) is beautifully crafted by these people and a bunch of awesome [contributors](https://github.com/sebastienrousseau/password-generator/graphs/contributors)