Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ins0 authored Jul 3, 2024
1 parent 35ec37a commit 7028c00
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Password-Tools-JS
# password-tools-js

A JS library to implement policy-driven password validation and generation

Expand All @@ -7,7 +7,7 @@ A JS library to implement policy-driven password validation and generation
Example:

```
import { Policy } from "@mittwald/password-validation";
import { Policy } from "@mittwald/password-tools-js";
const policy = await Policy.fromDeclarationRemote("https://api.mittwald.de/v2/password/policies/", "examplePolicy");
const result = policy.validate("password#");
Expand All @@ -16,7 +16,7 @@ const result = policy.validate("password#");
or

```
import { Policy, RemotePolicyLoader } from "@mittwald/password-validation";
import { Policy, RemotePolicyLoader } from "@mittwald/password-tools-js";
const remotePolicyLoader = new RemotePolicyLoader("https://api.mittwald.de/v2/password/policies/");
const policyDeclaration = await remotePolicyLoader.loadPolicy("examplePolicy");
Expand Down Expand Up @@ -47,16 +47,16 @@ const passphrase = Generator.generateAnyPassphrase();
## CLI

```
❯ yarn password-validation
password-validation <cmd> [options] ─╯
❯ yarn password-tools-js
password-tools-js <cmd> [options] ─╯
Commands:
password-validation validate-policies Validates all policies in the provided paths
password-validation validate-passwords Validates passwords against the provided policy
password-validation generate-password Generates a password from a policy
password-validation generate-any-password Generates any password
password-validation generate-passphrase Generates a passphrase from a policy
password-validation generate-any-passphrase Generates any passphrase
password-tools-js validate-policies Validates all policies in the provided paths
password-tools-js validate-passwords Validates passwords against the provided policy
password-tools-js generate-password Generates a password from a policy
password-tools-js generate-any-password Generates any password
password-tools-js generate-passphrase Generates a passphrase from a policy
password-tools-js generate-any-passphrase Generates any passphrase
Examples:
validate-policies -P my/policies/ foo/anotherPolicyDir/
Expand Down

0 comments on commit 7028c00

Please sign in to comment.