From b14b2ac36b238ea9042008f5679bbf707bdd02d2 Mon Sep 17 00:00:00 2001
From: Nils Pukropp <nils.pukropp@outlook.de>
Date: Wed, 12 May 2021 05:32:02 +0200
Subject: [PATCH] updated readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 06392e5..8c92ffb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# ytd-rs
\ No newline at end of file
+# ytd-rs
+
+This is a simple wrapper for [youtube-dl](https://youtube-dl.org/) in rust.
+
+```rust
+// youtube-dl arguments quietly run process and to format the output
+// one doesn't take any input and is an option, the other takes the desired output format as input
+let args = vec![Arg::new("--quiet"), Arg::new_with_arg("--output", "%(title).90s.%(ext)s")];
+let link = "https://www.youtube.com/watch?v=uTO0KnDsVH0";
+let ytd = YoutubeDL::new("./path/to/download/directory", args, link).unwrap();
+
+// start download
+let download = ytd.download();
+
+// check what the result is and print out the path to the download or the error
+match download.result_type() {
+    ResultType::SUCCESS => println!("Your download: {}", download.output_dir().to_string());
+    ResultType::IOERROR | ResultType::FAILURE =>
+            println!("Couldn't start download: {}", download.output());
+};
+
+```
+
+
+
+