diff --git a/README.md b/README.md index c4cbfaf..6d1ee1f 100644 --- a/README.md +++ b/README.md @@ -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> { + 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?; +} +``` \ No newline at end of file