realaravinth/argon2-creds
1
0
Fork 0
Code Issues 1 Pull requests 6 Projects Releases Packages Wiki Activity

updated readme to match latest api

Browse source
This commit is contained in:
Aravinth Manivannan 2021-03-04 20:51:06 +05:30
parent 769bf21c61
commit ffe66b007d
Signed by: realaravinth
GPG key ID: AD9F0F08E855ED88
3 changed files with 50 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -41,7 +41,6 @@ argon2-creds = { version = "0.1", git = "https://github.com/realaravinth/argon2-
let config = Config::default(); let config = Config::default();
let password = "ironmansucks"; let password = "ironmansucks";
let hash = config.password(password).unwrap();
// email validation // email validation
config.email(Some("batman@we.net")).unwrap(); config.email(Some("batman@we.net")).unwrap();
@ -61,15 +60,20 @@ argon2-creds = { version = "0.1", git = "https://github.com/realaravinth/argon2-
[ConfigBuilder]: [ConfigBuilder]:
```rust ```rust
use argon2_creds::{ConfigBuilder, Config}; use argon2_creds::{Config, ConfigBuilder, PasswordPolicyBuilder};
fn main() { fn main() {
let config = ConfigBuilder::default() let config = ConfigBuilder::default()
.salt_length(32)
.username_case_mapped(false) .username_case_mapped(false)
.profanity(true) .profanity(true)
.blacklist(false) .blacklist(false)
.argon2(argon2::Config::default()) .password_policy(
PasswordPolicyBuilder::default()
.min(12)
.max(80)
.build()
.unwrap(),
)
.build() .build()
.unwrap(); .unwrap();

4
examples/complex.rs
View file

@ -1,4 +1,6 @@
//To gain fine-grained control over how credentials are managed, consider using ConfigBuilder: /* To gain fine-grained control over how credentials are managed,
* consider using ConfigBuilder:
*/
use argon2_creds::{Config, ConfigBuilder, PasswordPolicyBuilder}; use argon2_creds::{Config, ConfigBuilder, PasswordPolicyBuilder};

5
examples/simple.rs
View file

@ -1,5 +1,6 @@
// The easiest way to use this crate is with the default configuration. See `Default` /* The easiest way to use this crate is with the default configuration.
// implementation for the default configuration. * See `Default` implementation for the default configuration.
*/
use argon2_creds::Config; use argon2_creds::Config;