Skip to content

Commit

Permalink
README.md updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
mindeng committed Jan 14, 2024
1 parent 7e0d325 commit 67d75b9
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,29 @@ A Django-managed password is a hashed password stored by Django.
See [Password management in Django][1] for more information.

[1]: https://docs.djangoproject.com/en/5.0/topics/auth/passwords/

## Library Usage

See:

- [docs.rs](https://docs.rs/clap/latest/django-auth/)
- [examples](examples/)

## CLI Tool Usage

`cargo run --example auth`:

```example
Authenticate or generate Django-managed passwords
Usage: auth <COMMAND>
Commands:
encode Encode a password in Django-style
verify Verify a Django stored hashed password
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```

0 comments on commit 67d75b9

Please sign in to comment.