oxibooru-client/szurubooru-client/README.md
2024-08-09 09:18:12 -07:00

26 lines
808 B
Markdown

# szurubooru-client
SzurubooruClient is a wrapper around the excellently-documented Szurubooru API,
including type-safe (if not API-safe) Query and Sort tokens.
## Creating a new client
### Basic authentication
Please keep in mind that this is not the preferred method of authentication. Tokens
are far superior.
```rust
use szurubooru_client::SzurubooruClient;
let client = SzurubooruClient::new_with_basic_auth("http://localhost:5001", "myuser",
"mypassword", true).unwrap();
```
### Token authentication
The far superior and more secure means of authentication
```rust
use szurubooru_client::SzurubooruClient;
let client = SzurubooruClient::new_with_token("http://localhost:5001", "myuser", "sz-123456", true).unwrap();
```
For all other methods for making the requests, see the documentation.