Update README.md

This commit is contained in:
JSTAR 2024-11-11 21:44:40 +05:00 committed by GitHub
parent 70fe00ebb0
commit 5daae99924
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,20 +1,26 @@
# 🌟 JSTAR Tab v2.0.0 # 🌟 JSTAR Tab v2.5.0
Welcome to **JSTAR Tab v2.0.0**! This is a customizable new tab extension for your browser, designed to enhance your browsing experience with personalization options, shortcuts, and more. 🚀 Welcome to **JSTAR Tab v2.5.0**! This is a customizable new tab extension for your browser, designed to enhance your browsing experience with personalization options, shortcuts, and more. 🚀
## 🎉 What's New in v2.0.0? ## 🎉 What's New in v2.5.0?
- **Improved Shortcuts**: Add, edit, and manage up to 12 shortcuts with ease. 🔗 - **Custom Greeting Format**: Create personalized greetings using format tags like {name}, {time}, {date}, {day}, {month}, and {year}! 🎯
- **Enhanced Personalization**: Set your display name and toggle anonymous mode to hide your name and shortcuts. 🕵️‍♂️ - **Improved UI**: Enhanced visual consistency and responsiveness across different screen sizes. 🎨
- **Data Management**: Import, export, and reset your settings and shortcuts. 📦 - **Bug Fixes**:
- **Notifications**: Get instant feedback with our new notification system. 🔔 - Fixed scrollbar appearance in settings modal
- **Onboarding Process**: A guided setup to personalize your experience right from the start. 🎓 - Improved theme toggle behavior
- Enhanced greeting format validation
- Better mobile device support
- Various CSS and layout improvements
## 📥 Installation ## 📥 Installation
To set up JSTAR Tab locally, follow these steps: 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.
1. **Download the Latest Release**: [JSTAR Tab v2.0.0](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest) Alternative Manual Installation:
1. **Download the Latest Release**: [JSTAR Tab v2.5.0](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest)
2. **Extract the Files**: Unzip the downloaded file to a directory of your choice. 2. **Extract the Files**: Unzip the downloaded file to a directory of your choice.
3. **Load the Extension**: 3. **Load the Extension**:
- Open your browser and navigate to the extensions page. - Open your browser and navigate to the extensions page.
@ -23,23 +29,30 @@ To set up JSTAR Tab locally, follow these steps:
## 🛠️ Features ## 🛠️ Features
- **Custom Greeting Format**: Create unique greetings using various format tags. 📝
- **Customizable Themes**: Choose between light and dark themes to suit your mood. 🌗 - **Customizable Themes**: Choose between light and dark themes to suit your mood. 🌗
- **Personalized Greeting**: Set a custom greeting with your name.
- **Search Engine Selection**: Choose your preferred search engine from a variety of options. - **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. - **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. - **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. - **Onboarding Process**: A step-by-step guide to help you set up your new tab with ease.
## 🎨 Customizing Your JSTAR Tab ## 🎨 Customizing Your Greeting
1. **Onboarding**: When you first install the extension, you'll be guided through an onboarding process to set up your preferences, including your name and preferred search engine. 1. **Format Tags**: Use these tags in your custom greeting:
2. **Themes**: Switch between light and dark themes using the theme toggle button in the settings. This changes the overall appearance of your new tab. - `{name}`: Your display name
3. **Greeting**: Personalize your greeting by entering your name in the settings. This will display a friendly message each time you open a new tab. - `{time}`: Current time
4. **Shortcuts**: Add shortcuts to your most visited sites. Click the "+" button to add a new shortcut, enter the name and URL, and save. You can also edit or delete shortcuts by right-clicking on them. - `{date}`: Current date
5. **Search Engine**: Select your preferred search engine from the settings. This will be used for all searches performed from the new tab. - `{day}`: Day of the week
- `{month}`: Current month
- `{year}`: Current year
2. **Examples**:
- "Hello {name}, it's {time} on {day}!"
- "Welcome back {name}! Today is {date}"
- "Happy {day}, {name}!"
## 📚 Usage ## 📚 Usage
- **Settings**: Click the settings icon ⚙️ to open the settings panel where you can customize your experience. - **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. - **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. - **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. - **Theme Toggle**: Switch between light and dark themes using the theme toggle button.