aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBobby <[email protected]>2025-09-23 02:24:57 +0530
committerGitHub <[email protected]>2025-09-23 02:24:57 +0530
commit6ca82486f8606f3689c600e16df079a9e49d570a (patch)
treefbd811e80e616220e9d42e8f61f4bf4b691bda69 /README.md
parent7a61ce4f81bd4a900d3ce3b7647540c9471dd316 (diff)
downloadthunderbird-ai-compose-6ca82486f8606f3689c600e16df079a9e49d570a.tar.xz
thunderbird-ai-compose-6ca82486f8606f3689c600e16df079a9e49d570a.zip
Rename README to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be184cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+![Thunderbird AI Compose Banner](./banner.png)
+
+## 📦 Installation (Development Build)
+
+1. Clone the repository:
+
+ ```bash
+ git clone https://github.com/luciferreeves/thunderbird-ai-compose.git
+ cd thunderbird-ai-compose
+ ```
+
+2. Install dependencies:
+
+ ```bash
+ npm install
+ ```
+
+3. Build the extension:
+
+ ```bash
+ npm run build
+ ```
+
+4. Open Thunderbird and go to:
+
+ `Tools` → `Developer Tools` → `Debug Add-ons` → `Load Temporary Add-on`
+
+
+5. Select the generated `manifest.json` inside the `build/` folder.
+
+## License
+
+This project is licensed under the **MIT License**. See [LICENSE](./LICENSE) for details.