JSTAR-Tab/README.md

67 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

2024-11-10 17:43:52 +00:00
# 🌟 JSTAR Tab v2.0.0
2024-11-10 17:15:48 +00:00
2024-11-10 17:43:52 +00:00
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. 🚀
## 🎉 What's New in v2.0.0?
- **Improved Shortcuts**: Add, edit, and manage up to 12 shortcuts with ease. 🔗
- **Enhanced Personalization**: Set your display name and toggle anonymous mode to hide your name and shortcuts. 🕵️‍♂️
- **Data Management**: Import, export, and reset your settings and shortcuts. 📦
- **Notifications**: Get instant feedback with our new notification system. 🔔
- **Onboarding Process**: A guided setup to personalize your experience right from the start. 🎓
2024-11-10 17:15:48 +00:00
## 📥 Installation
To set up JSTAR Tab locally, follow these steps:
2024-11-10 17:43:52 +00:00
1. **Download the Latest Release**: [JSTAR Tab v2.0.0](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest)
2024-11-10 17:15:48 +00:00
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.
## 🛠️ Features
2024-11-10 17:43:52 +00:00
- **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.
- **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.
2024-11-10 17:15:48 +00:00
## 🎨 Customizing Your JSTAR Tab
2024-11-10 17:43:52 +00:00
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.
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.
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.
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.
5. **Search Engine**: Select your preferred search engine from the settings. This will be used for all searches performed from the new tab.
2024-11-10 17:15:48 +00:00
## 📚 Usage
- **Settings**: Click the settings icon ⚙️ to open the settings panel where you can customize your experience.
2024-11-10 17:43:52 +00:00
- **Add Shortcuts**: Click the "+" button to add a new shortcut. Enter the name and URL, then save.
2024-11-10 17:15:48 +00:00
- **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.
## 📝 Contributing
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.
## 📄 License
2024-11-10 17:43:52 +00:00
This project is licensed under the MIT License. See the [LICENSE](https://github.com/DevJSTAR/JSTAR-Tab/blob/main/LICENSE) file for details.
2024-11-10 17:15:48 +00:00
## ❤️ Acknowledgments
- **Font Awesome**: For the beautiful icons used throughout the extension.
- **Google Fonts**: For the sleek and modern typography.
2024-11-10 17:43:52 +00:00
## 🌐 Connect with Us
- **[Linktree](https://linktr.ee/jstarsdev)**
- **[Patreon](https://patreon.com/jstarsdev)**
- **[Latest Release](https://github.com/DevJSTAR/JSTAR-Tab/releases/latest)**
Thank you for using JSTAR Tab! We hope it makes your browsing experience more enjoyable and productive. 🙂