Add readme

README.md

@@ -1,3 +1,42 @@
 # qBittorrent web api for Rust
 
-This is a qBittorrent api implementation automatically generated from the markdown file taken from here - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1).
+This is an automatic async implementation of the qBittorrent 4.1 web api. The api generation is based on the wiki markdown file which can be seen [here](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)).
+
+## Example
+
+```rust
+use anyhow::Result;
+use qbittorrent_web_api::Api;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let api = Api::login("http://localhost:8080", "admin", "adminadmin").await?;
+
+    // add a torrent
+    api.torrent_management()
+        .add("http://www.legittorrents.info/download.php?id=5cc013e801095be61d768e609e3039da58616fd0&f=Oddepoxy%20-%20Oddepoxy%20(2013)%20[OGG%20320%20CBR].torrent")
+        .send()
+        .await?;
+
+    // critical logs
+    let logs = api.log()
+        .main()
+        .critical(true)
+        .warning(false)
+        .normal(false)
+        .info(false)
+        .send()
+        .await?;
+
+    println!("{:#?}", &logs);
+
+    // current torrent info
+    let info = api.torrent_management().info().send().await?;
+
+    println!("{:#?}", info);
+
+    Ok(())
+}
+
+```
+

qbittorrent-web-api-gen/README.md

@@ -0,0 +1 @@
+This is the implementation for the crate `qbittorrent-web-api` - use that crate instead.