Reorganizing and documenting
This commit is contained in:
parent
8d57f5d9de
commit
5fc286fb09
14 changed files with 2341 additions and 175 deletions
26
szurubooru-client/README.md
Normal file
26
szurubooru-client/README.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# 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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue