From 6e076575f275f4c2b5811086b4a68304946024c1 Mon Sep 17 00:00:00 2001 From: JSTAR <78903532+DevJSTAR@users.noreply.github.com> Date: Sat, 14 Dec 2024 14:52:27 +0500 Subject: [PATCH] Update README.md --- README.md | 117 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 61 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 92520f3..43e18af 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,82 @@ -# 🌟 JSTAR Tab v2.6.2 +# 🌟 JSTAR Tab -Welcome to **JSTAR Tab v2.6.2**! This version builds upon the previous release with new features and improvements to enhance your browsing experience even further. 🚀 +Welcome to **JSTAR Tab**, the ultimate customizable new tab extension for your browser! Whether you're looking for a sleek, modern design or powerful personalization options, JSTAR Tab has you covered. 🚀 -## 🎉 What's New in v2.6.2? +Transform your browsing experience with custom greetings, themes, shortcuts, and more. 🎉 -- **New/Improved animations**: Experience the new responsive animations in the new update! +## ✨ Features -## 📥 Installation +- **Custom Greeting Formats**: Create personalized greetings using dynamic format tags: + - `{name}`: Your display name + - `{greeting}`: Time-based greeting (e.g., Good morning) + - `{time}`: Current time + - `{date}`: Current date + - `{day}`: Day of the week + - `{month}`: Current month + - `{year}`: Current year -1. Visit [JSTAR Tab Website](https://jstartab.netlify.app) -2. Select your browser or mobile browser from the available options. -3. Follow the installation instructions specific to your browser. + Examples: + - "Hello {name}, it's {time} on {day}!" + - "{greeting}, {name}! Today is {date}" + - "Happy {day}, {name}!" -Alternative Manual Installation: -1. **Download the Latest Release**: [JSTAR Tab v2.6.2](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest) -2. **Extract the Files**: Unzip the downloaded file to a directory of your choice. -3. **Load the Extension**: - - Open your browser and navigate to the extensions page. - - Enable "Developer mode" (usually a toggle in the top right corner). - - Click "Load unpacked" and select the directory where you extracted the files. +- **Customizable Themes**: Switch between light and dark modes to suit your mood. 🌗 +- **Shortcut Management**: Add, edit, and remove shortcuts to your favorite websites. +- **Search Engine Selection**: Choose your preferred search engine for quick and efficient browsing. +- **Keyboard Shortcuts**: Set up custom keybinds for various actions: + - Open settings + - Add a new shortcut + - Toggle anonymous mode + - Change themes + - Redirect to a specific URL (with a notification and "Redirecting to..." message) -## 🛠️ Features +- **Data Backup and Restore**: Export and import your settings and shortcuts effortlessly. -- **Custom Greeting Format**: Create unique greetings using various format tags. 📝 -- **Customizable Themes**: Choose between light and dark themes to suit your mood. 🌗 -- **Search Engine Selection**: Choose your preferred search engine from a variety of options. -- **Shortcut Management**: Easily add, edit, and remove shortcuts to your favorite sites. -- **Data Backup and Restore**: Export your settings and shortcuts to a file and import them back anytime. -- **Onboarding Process**: A step-by-step guide to help you set up your new tab with ease. -- **Keyboard Shortcuts**: Configure shortcuts for quick access to features. +## 🌐 Getting Started -## 🎨 Customizing Your Greeting +### Installation -1. **Format Tags**: Use these tags in your custom greeting: - - `{name}`: Your display name - - `{greeting}`: Time-based greeting (e.g., Good morning) - - `{time}`: Current time - - `{date}`: Current date - - `{day}`: Day of the week - - `{month}`: Current month - - `{year}`: Current year -2. **Examples**: - - "Hello {name}, it's {time} on {day}!" - - "{greeting}, {name}! Today is {date}" - - "Happy {day}, {name}!" +1. Visit [JSTAR Tab Website](https://jstartab.netlify.app). +2. Select your browser or mobile browser from the available options. +3. Follow the installation instructions specific to your browser. -## 📚 Usage +### Alternative Manual Installation -- **Settings**: Click the settings icon ⚙️ to open the settings panel where you can customize your experience. -- **Custom Greeting**: Enter your preferred greeting format in the settings panel. -- **Add Shortcuts**: Click the "+" button to add a new shortcut. Enter the name and URL, then save. -- **Edit Shortcuts**: Right-click on a shortcut to edit or delete it. -- **Theme Toggle**: Switch between light and dark themes using the theme toggle button. -- **Keyboard Shortcuts**: Use configured shortcuts for quick actions. +1. **Download the Latest Release**: [JSTAR Tab GitHub Releases](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest). +2. **Extract the Files**: Unzip the downloaded file to a directory of your choice. +3. **Load the Extension**: + - Open your browser and navigate to the extensions page. + - Enable "Developer mode" (usually a toggle in the top right corner). + - Click "Load unpacked" and select the directory where you extracted the files. -## 📝 Contributing +## 🎨 Customizing Your Experience -We welcome contributions! If you have suggestions or improvements, feel free to fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change. -Thanks JSTAR. +### **Greeting Formats** +Personalize your greeting with dynamic tags listed above. Example: "Good {greeting}, {name}! It's {time} on {day}!" -## 📄 License +### **Themes** +Toggle between light and dark themes from the settings panel. -This project is licensed under the [MIT License](https://github.com/DevJSTAR/JSTAR-Tab/blob/main/LICENSE). +### **Shortcuts** +Manage your favorite sites effortlessly: +- Add shortcuts with the "+" button. +- Edit or delete shortcuts by right-clicking on them. -## ❤️ Acknowledgments +### **Keyboard Shortcuts** +Set up custom keybinds for quick actions like opening settings or switching themes. -- **Font Awesome**: For the beautiful icons used throughout the extension. -- **Google Fonts**: For the sleek and modern typography. +## ❤️ Acknowledgments -## 🌐 Connect with Us +Special thanks to **[Equa](https://github.com/EquaTechnologies)** for contributing amazing hover animations for shortcuts, settings, and the "Add Shortcut" button. Your work is truly appreciated! 🌟 -- **[Linktree](https://linktr.ee/jstarsdev)** -- **[Patreon](https://patreon.com/jstarsdev)** -- **[Latest Release](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest)** +## 📄 License -Thank you for using JSTAR Tab! We hope it makes your browsing experience more enjoyable and productive. Meow? 🙂 +This project is licensed under the [MIT License](https://github.com/DevJSTAR/JSTAR-Tab/blob/main/LICENSE). + +## 🌐 Connect with Us + +- **[Linktree](https://linktr.ee/jstarsdev)** +- **[Patreon](https://patreon.com/jstarsdev)** +- **[GitHub Releases](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest)** + +Thank you for choosing JSTAR Tab! We hope you enjoy the seamless and personalized browsing experience it brings. 🚀