Rejoink-TAB/README.md

59 lines
2.7 KiB
Markdown
Raw Normal View History

2024-11-10 17:15:48 +00:00
# 🌟 JSTAR Tab v1.0.0
Welcome to **JSTAR Tab v1.0.0**! This extension transforms your new tab into a personalized dashboard with shortcuts, a search bar, and customizable settings. 🚀
## 📥 Installation
To set up JSTAR Tab locally, follow these steps:
1. **Download the Files**: Clone or download the repository to your local machine.
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
- **Customizable Themes**: Switch between light and dark themes to suit your mood. 🌗
- **Personalized Greeting**: Displays a greeting based on the time of day and your anonymization settings.
- **Search Bar**: Quickly search the web using Brave's search engine.
- **Shortcut Management**: Add, edit, and remove shortcuts to your favorite sites.
- **Settings Panel**: Access various settings including theme toggle and shortcut management.
- **Anonymization**: Toggle anonymization to hide your name in the greeting.
## 🎨 Customizing Your JSTAR Tab
1. **Themes**: Use the theme switch in the settings to toggle between light and dark modes.
2. **Greeting**: The greeting changes based on the time of day and whether anonymization is enabled.
3. **Shortcuts**:
- **Add**: Click the "Add Shortcut" button, enter a name and URL, and save.
- **Edit**: Right-click on a shortcut and select "Edit" to modify its details.
- **Delete**: Right-click on a shortcut and select "Delete" to remove it.
4. **Search Engine**: The search bar uses Brave's search engine by default.
## 📚 Usage
- **Settings**: Click the settings icon ⚙️ to open the settings panel where you can customize your experience.
- **Add Shortcuts**: Click the "+" button to add a new shortcut. Enter the URL and name, 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.
## 📝 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
This project is licensed under the [MIT License](https://github.com/DevJSTAR/JSTAR-Tab/blob/main/LICENSE).
## ❤️ Acknowledgments
- **Font Awesome**: For the beautiful icons used throughout the extension.
- **Google Fonts**: For the sleek and modern typography.
Thank you for using JSTAR Tab! We hope it makes your browsing experience more enjoyable and productive. 😊