chore: update README
This commit is contained in:
parent
9379dc18e5
commit
486f3ca7f7
20
README.md
20
README.md
@ -9,24 +9,14 @@ This library provides high-level functionality for creating, handling, and manag
|
|||||||
This library includes modules for defining claims, handling errors, and creating/verifying PASETO tokens.
|
This library includes modules for defining claims, handling errors, and creating/verifying PASETO tokens.
|
||||||
It leverages the `rusty_paseto` crate and currently supports PASETO Tokens V4.public.
|
It leverages the `rusty_paseto` crate and currently supports PASETO Tokens V4.public.
|
||||||
|
|
||||||
# Modules
|
|
||||||
|
|
||||||
- `claims`: Defines the structure and behavior of the claims that can be embedded in a PASETO token.
|
|
||||||
- `errors`: Provides error types and handling mechanisms for the library.
|
|
||||||
- `maker`: Contains the logic for creating and verifying PASETO tokens.
|
|
||||||
|
|
||||||
# Re-exports
|
|
||||||
|
|
||||||
- `Claims`: The struct representing the claims in a PASETO token.
|
|
||||||
- `Maker`: The struct used for creating and verifying PASETO tokens.
|
|
||||||
|
|
||||||
# Usage Example
|
# Usage Example
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
use paseto_maker::{Maker, Claims, version::V4, purpose::Public};
|
use paseto_maker::{Maker, Claims, version::V4, purpose::Public};
|
||||||
|
|
||||||
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
let maker = Maker::new_with_keypair().unwrap();
|
let (priv_key, _public_key) = Maker::new_keypair();
|
||||||
|
let maker = Maker::new(&priv_key).expect("failed to create maker");
|
||||||
let claims = Claims::new().with_subject("example");
|
let claims = Claims::new().with_subject("example");
|
||||||
let token = maker.create_token(&claims).unwrap();
|
let token = maker.create_token(&claims).unwrap();
|
||||||
println!("Token: {}", token);
|
println!("Token: {}", token);
|
||||||
@ -37,10 +27,4 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `claims` module defines the structure and behavior of the claims that can be embedded in a PASETO token.
|
|
||||||
The `errors` module provides error types and handling mechanisms for the library.
|
|
||||||
The `maker` module contains the logic for creating and verifying PASETO tokens.
|
|
||||||
|
|
||||||
The `Claims` struct and `Maker` struct are re-exported for ease of use.
|
|
||||||
|
|
||||||
This library uses the `rusty_paseto` crate underneath and currently only supports PASETO Tokens V4.public.
|
This library uses the `rusty_paseto` crate underneath and currently only supports PASETO Tokens V4.public.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user