feat: Add GitRepo Zip Fetcher functionality to download GitHub repositories as ZIP files

chinxcode · chinxcode · commit ba169ea79f9b · 2024-09-08T12:54:45.000+05:30
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# 🚀 GitRepo Zip Fetcher
+
+Effortlessly download GitHub repositories and folders as ZIP files with just a few clicks! 🖱️
+
+## ✨ Features
+
+-   📦 Fetch entire GitHub repos or specific folders
+-   🗜️ Download repositories as ZIP files
+-   🔒 Support for both public and private repositories
+-   🔑 Optional GitHub Personal Access Token integration
+-   📊 Real-time progress tracking
+-   📱 Responsive design for all your devices
+
+## 🚀 How to Use
+
+1. 🌐 Open the app in your favorite web browser
+2. 📝 Enter a GitHub repository URL
+3. 🔑 (Optional) Click "Use Token" to enter your GitHub Personal Access Token
+4. 🚀 Hit the "Fetch" button or press Enter
+5. 📊 Watch the progress in the status output area
+6. 💾 When it's done, your ZIP file will start downloading automatically!
+
+## 🛠️ Dependencies
+
+-   [JSZip](https://stuk.github.io/jszip/): ZIP file wizardry 🧙‍♂️
+-   [FileSaver.js](https://github.com/eligrey/FileSaver.js/): Download magic 🪄
+-   [Octokit](https://github.com/octokit/octokit.js): GitHub API sorcery 🔮
+
+## 📝 Note
+
+Your privacy is our top priority! 🛡️ This app runs entirely in your browser and doesn't collect or send any personal data. All operations happen on your device for maximum security. 🔒
+
+Enjoy fetching your GitHub repositories with ease! 🎉
