Skip to content

Commit c9223a1

Browse files
authored
Update README.md
1 parent a93ba13 commit c9223a1

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
11

2+
# **imoji Browser Extension 🚀**
3+
4+
**imoji** is a revolutionary, keyboard-first browser extension designed to supercharge your workflow. It instantly replaces emoji shortcodes (like :heart:) with their corresponding emojis ❤️ and integrates a powerful AI assistant directly into your browser.
5+
6+
This tool is built for users who value speed and efficiency, allowing you to find emojis and get answers without ever leaving your text box or switching tabs.
7+
8+
*(Note: This links to the icon in the repo. It would be better to replace this with a GIF showing the extension in action\!)*
9+
10+
## **✨ Core Features**
11+
12+
* **Instant Emoji Shortcodes:** Simply type a shortcode like :lol: or :rocket: and press the spacebar to have it instantly replaced with the correct emoji (😂 or 🚀).
13+
* **Custom Emoji Manager:** Add your own personal shortcodes\! The settings page allows you to map any shortcode you want (e.g., :brb:) to any emoji (e.g., 💨).
14+
* **Built-in AI Assistant:** Get answers and information on the fly without opening a new tab.
15+
* **AI Right-Click Menu:** The recommended way to use the AI. Simply highlight any text on any webpage, right-click, and select "Ask Imoji about..." to get an instant explanation or more information.
16+
* **AI Text Command:** For power users, type :ai followed by your question (e.g., :ai what is the capital of Japan) and press spacebar twice to get an answer.
17+
18+
## **📦 Installation**
19+
20+
The imoji extension is being prepared for public release.
21+
22+
**Get it from the Chrome Web Store (Link Coming Soon)**
23+
24+
## **💻 Tech Stack**
25+
26+
This project combines a lightweight frontend extension with a robust backend to handle AI requests.
27+
28+
* **Frontend:** HTML, CSS, JavaScript (Browser Extension APIs)
29+
* **Backend Server:** Custom Web Server (e.g., Node.js/Express)
30+
* **Hosting:** Server deployed on [Railway](https://railway.app/)
31+
* **AI Model:** [Deepseek V3.1](https://www.deepseek.com/)
32+
* **API Routing:** [OpenRouter](https://openrouter.ai/) for flexible AI model access
33+
* **Deployment:** Continuous integration and deployment via [GitHub](https://github.com/)
34+
35+
## **👤 Creator**
36+
37+
This extension was created by:
38+
R H A Ashan Imalka
39+
40+
* [GitHub Profile](https://github.com/scxr-dev)
41+
42+
## **© License & Copyright**
43+
44+
Copyright © 2025 R H A Ashan Imalka. All Rights Reserved.
45+
46+
This project is proprietary and closed-source. You may not copy, modify, distribute, or sublicense the software or any part of it without the express written permission of the copyright holder.

0 commit comments

Comments
 (0)