From 4431ee41ac732bb41efff0ea9ecc1470f0d5d82b Mon Sep 17 00:00:00 2001
From: aandrew-me <ahammadandrew@protonmail.com>
Date: Mon, 25 Jul 2022 22:23:25 +0600
Subject: [PATCH] Adding README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a2475c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# YouTube Downloader
+A GUI for downloading Video and Audio files from YouTube using Nodejs and Electron
+
+[Nodejs](https://nodejs.org/) (along with npm) needs to be installed.
+
+Required commands to get started.
+```
+git clone https://github.com/aandrew-me/ytDownloader.git
+cd ytDownloader
+npm i
+```
+
+To run with Nodejs :
+```
+node app
+```
+To run with [Electron](https://www.electronjs.org/) :
+```
+npm start
+```
\ No newline at end of file