From bc43b2c41b2645f9a71b1f58f0e85af5b91626a5 Mon Sep 17 00:00:00 2001
From: Marco Rieger <m.rieger@mittwald.de>
Date: Wed, 3 Jul 2024 15:01:19 +0200
Subject: [PATCH] Update README.md

---
 README.md | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 752347d..3227de5 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
-# password-tools-js
+# @mittwald/password-tools-js
+
+![Tests](https://github.com/mittwald/password-tools-js/workflows/Compilation%20&%20Unit%20Tests/badge.svg)
 
 A JS library to implement policy-driven password validation and generation
 
-## Validate Passwords
+## Installation
+
+### Yarn
+`yarn add @mittwald/password-tools-js`
+
+### NPM
+`npm install @mittwald/password-tools-js`
+
+## Usage
+### Validate Passwords
 
 Example:
 
@@ -25,7 +36,7 @@ const policy = Policy.fromDeclaration(policyDeclaration);
 const result = policy.validate("password#");
 ```
 
-## Generate password/passphrase
+### Generate password/passphrase
 
 from a policy:
 
@@ -44,7 +55,7 @@ const password = Generator.generateAnyPassword();
 const passphrase = Generator.generateAnyPassphrase();
 ```
 
-## CLI
+## CLI (Node)
 
 ```
 ❯ yarn password-tools-js