(chore): initial MVP release v0.1.0

2025-12-19 21:03:02 +05:30 · 2025-05-01 21:39:12 +05:30
commit bd9483374f
36 changed files with 10146 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,62 @@
+# NeoDLP Extension
+
+NeoDLP (Neo Downloader Plus) Browser Integration
+
+[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/neosubhamoy/neodlp-extension)
+[![github tag](https://img.shields.io/github/v/tag/neosubhamoy/neodlp-extension?color=yellow)](https://github.com/neosubhamoy/neodlp-extension)
+[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/neosubhamoy/neodlp-extension)
+
+> **🥰 Liked this project? Please consider giving it a Star (🌟) on github to show us your appreciation and help the algorythm recommend this project to even more awesome people like you!**
+
+### 📎 Pre-Requirements
+
+- [NeoDLP](https://github.com/neosubhamoy/neodlp) (Installed and Running)
+
+### ⬇️ Download and Installation
+
+#### Manual Installation (in Google Chrome / Chromium based browsers)
+
+1. Download the `neodlp-extension-<version>-chrome.zip` file from the [latest release](https://github.com/neosubhamoy/neodlp-extension/releases).
+2. Extract the `.zip` file (using any zip extractor software. eg: 7zip, WinRAR etc.).
+3. Open Google Chrome and navigate to `chrome://extensions/`.
+4. Enable "Developer mode" in the top right corner.
+5. Click on "Load unpacked" and select the newly extracted folder. Done! That's it...!!
+
+#### Manual Installation (in Mozilla Firefox)
+
+1. Download the `neodlp-extension-<version>-firefox.zip` file from the [latest release](https://github.com/neosubhamoy/neodlp-extension/releases).
+2. Open Firefox and navigate to `about:addons`.
+3. Click on the gear icon (top right) and select "Install Add-on From File...".
+4. Select the downloaded `.zip` file. Done! That's it...!!
+
+### ⚡ Technologies Used
+
+![WXT](https://img.shields.io/badge/WXT-67D55E.svg?style=for-the-badge&logo=WXT&logoColor=white)
+![React](https://img.shields.io/badge/React-61DAFB.svg?style=for-the-badge&logo=React&logoColor=black)
+![TypeScript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=for-the-badge&logo=TypeScript&logoColor=white)
+![ShadCnUi](https://img.shields.io/badge/shadcn/ui-000000.svg?style=for-the-badge&logo=shadcn/ui&logoColor=white)
+
+### 🛠️ Contributing / Building from Source
+
+Want to be part of this? Feel free to contribute...!! Pull Requests are always welcome...!! (^_^) Follow these simple steps to start building:
+
+* Make sure to install Node.js, Git before proceeding.
+1. Fork this repo in your github account.
+2. Git clone the forked repo in your local machine.
+3. Install Node.js dependencies: `npm install`
+4. Run development / build / zipping process
+```code
+npm run dev              # for development (chrome)
+npm run dev:firefox      # for development (firefox)
+npm run build            # for production build (chrome)
+npm run build:firefox    # for production build (firefox)
+npm run zip              # for production zip creation (chrome)
+npm run zip:firefox      # for production zip creation (firefox)
+```
+5. Do the changes, Send a Pull Request with proper Description (NOTE: Pull Requests Without Proper Description will be Rejected)
+
+**⭕ Noticed any Bugs or Want to give us some suggetions? Always feel free to open a GitHub Issue. We would love to hear from you...!!**
+
+### 📝 License
+
+NeoDLP Extension is Licensed under the [MIT license](https://github.com/neosubhamoy/neodlp-extension/blob/main/LICENSE). Anyone can view, modify, use (personal and commercial) or distribute it's sources without any attribution and extra permissions.