aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..cd0fb53
--- /dev/null
+++ b/README
@@ -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.