Add decent README.md

This commit is contained in:
Leon Grünewald 2024-01-01 22:16:58 +01:00
parent 8d100a9568
commit fa5b3cc274

View file

@ -1 +1,55 @@
# r621
A simple e621 client using requwest.
## Features
### Implemented
- Post
- Listing
### Missing
- Post
- Create
- Update
- Flag
- Vote
- Favorite
- Favorites
- Listing
- Create
- Delete
- Tags
- Listing
- Tag Aliases
- Listing
- Tag Implications
- Listing
- Notes
- Listing
- Create
- Update
- Pools
- Listing
- Create
- Update
- Revert
## Example Usage
```rust
use r621::client::{Authentication, Client};
use r621::post::Post;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let user_agent = "MyProject/1.0 (by username on e621)";
let auth = Authentication::Authorized {
username: "hexerade",
apikey: "1nHrmzmsvJf26EhU1F7CjnjC"
};
let mut esix_client = Client::new(auth, user_agent);
let posts = esix_client.list_posts(None, query, None).await?;
}
```