From 5187a404605659234485464046703cdaa8b9cf78 Mon Sep 17 00:00:00 2001
From: trivernis <trivernis@protonmail.com>
Date: Sun, 24 Jul 2022 12:23:20 +0200
Subject: [PATCH] Add README

Signed-off-by: trivernis <trivernis@protonmail.com>
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1f9f8d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# aur-rpc
+
+This crate is an async wrapper for calls to the Arch Linx User Repository.
+
+## Example
+
+```rust
+#[tokio::main]
+pub async fn main() {
+   let packages = aur_rpc::search("yay").await.unwrap();
+
+   for package in packages {
+       println!("{} - {}", package.name, package.maintainer);
+   }
+   
+   let mut infos = aur_rpc::info(["mediarepo"]).await.unwrap();
+   let info = infos.pop().expect("package not found");
+   println!("{}", info.metadata.popularity);
+}
+```
+
+## License
+
+Apache 2.0