Skip to content

Commit f4f58af

Browse files
Add comprehensive README with project overview and setup instructions
1 parent e06f7b3 commit f4f58af

File tree

3 files changed

+57
-0
lines changed

3 files changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# 🎨 Teams Emoji Upload Extension
2+
3+
> Effortlessly bulk upload custom emojis to your Microsoft Teams organization with just a few clicks!
4+
5+
![Screenshot](./readme/screenshot.png)
6+
7+
## ✨ Features
8+
9+
- Bulk upload multiple emoji files simultaneously
10+
- Works via Teams in the browser
11+
12+
## 📋 Prerequisites
13+
14+
- Active Microsoft Teams tab in Chrome
15+
16+
## 🚀 Installation
17+
18+
### From Chrome Web Store
19+
20+
⏳ Coming soon! Extension is pending approval.
21+
22+
### From Source
23+
24+
1. Clone this repository
25+
2. Install dependencies and build:
26+
```console
27+
npm install
28+
npm run build
29+
npm test
30+
```
31+
3. Open Chrome and navigate to `chrome://extensions`
32+
4. Enable "Developer Mode" in the top right
33+
5. Click "Load Unpacked" and select this repository folder
34+
35+
![Unpack Instructions](./readme/unpack.png)
36+
37+
> 💡 **Tip**: After making changes, rebuild the project and refresh the extension in Chrome
38+
39+
## 🛠️ Development
40+
41+
### Formatting Code
42+
```console
43+
npx prettier . --write
44+
```
45+
46+
### Running Tests
47+
```console
48+
npm test
49+
```
50+
51+
## 🤝 Contributing
52+
53+
Contributions are welcome! Please feel free to submit a Pull Request.
54+
55+
## 📄 License
56+
57+
[MIT License](LICENSE)

readme/screenshot.png

9.73 KB
Loading

readme/unpack.png

41.8 KB
Loading

0 commit comments

Comments
 (0)