From 5c6fab330dd16859777a9b4c1940d1a0829a2fa2 Mon Sep 17 00:00:00 2001
From: Rocktim Saikia <rocktimthedev@gmail.com>
Date: Sun, 1 Sep 2024 13:54:23 +0530
Subject: [PATCH] Update README with project details and usage instructions

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c22386b..5f3746a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
-# github-dl
+# Github-dl
+
+Download individual files and folders from Github without needing to clone the entire repo.
 
 [![Tests](https://github.com/rocktimsaikia/github-dl/actions/workflows/tests.yml/badge.svg)](https://github.com/rocktimsaikia/github-dl/actions/workflows/tests.yml)
+
+## Motivation
+
+The project aims to save time and resources by allowing users to download only the specific folders and files they need from a GitHub repository, without the hassle of cloning the entire repo. It's designed for efficiency, making development and learning more streamlined.
+
+## Install
+
+```sh
+pip install github-dl
+```
+
+or using [pipx](https://pipx.pypa.io/)
+
+```sh
+pipx install cambd
+```
+
+## Usage
+
+> Using the tool is straightforward, copy the Github URL of the target repository folder and paste it after the command `github-dl` or it's alias `gh-dl`.
+
+```sh
+github-dl <github_path>
+
+# Example
+github-dl https://github.com/linuxdotexe/nordic-wallpapers/tree/master/dynamic-wallpapers/Coast
+```
+
+\
+Find all available options using `--help`
+
+```sh
+usage: github-dl [-h] [-o] [-v] github_path
+
+Download folders and files from Github.
+
+positional arguments:
+  github_path     Github directory full URL path
+
+options:
+  -h, --help      show this help message and exit
+  -o , --output   Destination directory to download to
+  -v, --version   show program version number and exit
+
+Thanks for using github-dl!
+```