|
| 1 | +#  Quotely - A Extension |
| 2 | + |
| 3 | +💬 **Quotely** delivers daily inspiration right to your side panel. With a sleek modern interface, dark mode, and local quote storage, it makes saving and bookmarking your favorite quotes easy. Designed for clarity, personalization, and simplicity, Quotely is your lightweight companion for daily motivation. |
| 4 | + |
| 5 | +## 📜 Table of Contents |
| 6 | +<details> |
| 7 | +<summary><strong>Table of Contents 📜</strong></summary> |
| 8 | + |
| 9 | +- [✨ Features](#-features) |
| 10 | +- [📸 Screenshots](#-screenshots) |
| 11 | +- [🌐 Browser Support](#-browser-support) |
| 12 | +- [📥 Installation](#-installation) |
| 13 | +- [📝 Usage](#-usage) |
| 14 | +- [🚀 Language Support](#-language-support) |
| 15 | +- [🤝 Contributing](#-contributing) |
| 16 | +- [🤔 FAQ](#-faq) |
| 17 | +- [💬 Feedback](#-feedback) |
| 18 | +- [👥 Community](#-community) |
| 19 | +- [⚠️ Other](#-other) |
| 20 | +- [🛠️ License](#-license) |
| 21 | + |
| 22 | +</details> |
| 23 | + |
| 24 | +## ✨ Features |
| 25 | +- 💬 **Dynamic Quotes**: Get a fresh quote each time with author, category & year. |
| 26 | +- 🔖 **Bookmark Favorites**: Save your favorite quotes locally. |
| 27 | +- ➕ **Add Your Own**: Easily create and view your custom quotes. |
| 28 | +- 🗑️ **Manage**: Delete bookmarks or custom quotes anytime. |
| 29 | +- 🌒 **Dark Mode**: Switch themes with a single click. |
| 30 | +- ⚙️ **Settings**: Central place for future features. |
| 31 | +- 📤 **Share Quotes**: Copy quotes and share them via social media. |
| 32 | +- 📚 **Organized Metadata**: View year, source, and more. |
| 33 | +- 🎨 **Beautiful Design**: A clean design and smooth layout. |
| 34 | + |
| 35 | +## 📸 Screenshots |
| 36 | +| Light Mode | Dark Mode | |
| 37 | +|------------|-----------| |
| 38 | +|  |  | |
| 39 | + |
| 40 | +_**Note**: You can find the screenshot files in the `/assets/screenshots` folder._ |
| 41 | + |
| 42 | +## 🌐 Browser Support |
| 43 | + |
| 44 | +| Browser | Support | Notes | |
| 45 | +|--------|--------|-------| |
| 46 | +| **Chrome** | ✅ Full Support | No further notes. | |
| 47 | +| **Edge** | ✅ Full Support | No further notes. | |
| 48 | + |
| 49 | +ℹ️ **Quotely is built and optimized for Google Chrome**. Other browsers may not provide full functionality due to missing or experimental API support. |
| 50 | + |
| 51 | +## 📥 Installation |
| 52 | +1. Clone this repository: |
| 53 | + ```sh |
| 54 | + git clone https://github.com/flamevel/quotely.git |
| 55 | + ``` |
| 56 | +2. Open Chrome and go to `chrome://extensions/`. |
| 57 | +3. Enable **Developer mode** (top right corner). |
| 58 | +4. Click **Load unpacked** and select the `QuotelyExtension` project folder. |
| 59 | + |
| 60 | +## 📝 Usage |
| 61 | +- Click the **side panel icon** to open Quotely |
| 62 | +- Use the top icons to switch theme or open settings |
| 63 | +- Click **reload** to get a new quote |
| 64 | +- Add your own quotes via the **add** button |
| 65 | +- Save favorites with the **bookmark** icon and share them via the **share** icon |
| 66 | +- All data is stored locally (bookmarks, theme, etc.) |
| 67 | + |
| 68 | +## 🚀 Language Support |
| 69 | +Currently supports only **English**, internationalization is planned. |
| 70 | + |
| 71 | +## 🤝 Contributing |
| 72 | +Contributions are welcome! Feel free to fork this repository and submit pull requests for improvements. |
| 73 | + |
| 74 | +## 🤔 FAQ |
| 75 | +**Q: Can I request new features?** |
| 76 | +A: Absolutely! Open an issue on GitHub with your request or join our community. |
| 77 | + |
| 78 | +**Q: Where are my bookmarks stored?** |
| 79 | +A: All data is saved locally using `chrome.storage.local`. |
| 80 | + |
| 81 | +**Q: Where can I find the qoutes?** |
| 82 | +A: You can find the quotes in `src/data/quotes.json`. |
| 83 | + |
| 84 | +## 💬 Feedback |
| 85 | +Have suggestions or found a bug? Open an issue on [GitHub](https://github.com/flamevel/quotely/issues). |
| 86 | + |
| 87 | +## 👥 Community |
| 88 | +Join our community on Discord to discuss features, report issues, and get support: |
| 89 | + |
| 90 | +<div align="left"> |
| 91 | + <a href="https://discord.gg/hTrvqqHA3g"><img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Discord/discord1.svg" height="30"></a> |
| 92 | + <a href="https://github.com/Flamevel"><img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Github/github3.svg" height="30"></a> |
| 93 | +</div> |
| 94 | + |
| 95 | +## ⚠️ Other |
| 96 | +> [!NOTE] |
| 97 | +> Please note this extension is still in development and may contain bugs. |
| 98 | +
|
| 99 | +> [!IMPORTANT] |
| 100 | +> If you like this project, consider ⭐ **starring** the repository. |
| 101 | +
|
| 102 | +## 🛠️ License |
| 103 | +This project is licensed under the **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)** License. |
| 104 | +See the [LICENSE](LICENSE) file for details. |
0 commit comments