Skip to content

Commit a09dda6

Browse files
committed
docs: update install guide with AMO instructions
1 parent 92c045b commit a09dda6

1 file changed

Lines changed: 30 additions & 58 deletions

File tree

INSTALL_GUIDE.md

Lines changed: 30 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,50 @@
11
# Installation Guide
22

3-
## Prerequisites
3+
## 🚀 Install from Firefox Add-ons (Recommended)
44

5-
- **Firefox** version 128.0 or later
6-
- An active **Outlook Web App (OWA)** or **Outlook 365** account accessible in your browser
5+
Users can install the extension directly from the official Mozilla Add-ons page:
76

8-
## Method 1: Temporary Installation (Development / Testing)
7+
[OWA Notifications on Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/owa-notifications-by-mbahnizen/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search)
98

10-
1. Open Firefox and navigate to `about:debugging`
11-
2. Click **This Firefox** in the sidebar
12-
3. Click **Load Temporary Add-on...**
13-
4. Navigate to the `src/` directory of this project
14-
5. Select the `manifest.json` file
15-
16-
> **Note**: Temporary add-ons are removed when Firefox is closed. This method is ideal for testing.
17-
18-
## Method 2: Permanent Installation (Signed .xpi)
9+
**Steps:**
10+
1. Open the link above in Firefox
11+
2. Click **"Add to Firefox"**
12+
3. Confirm installation
1913

20-
Firefox requires add-ons to be signed by Mozilla for permanent installation.
14+
That's it — the extension is ready to use!
2115

22-
### Step 1: Create a ZIP package
16+
---
2317

24-
1. Navigate **inside** the `src/` directory
25-
2. Select **all files** (`manifest.json`, `background.js`, `content-script.js`, `options.html`, `options.js`, `options.css`, icons, etc.)
26-
3. Compress them into a ZIP file (e.g., `owa-notifications.zip`)
18+
## 🛠 Troubleshooting
2719

28-
> **Important**: The `manifest.json` must be at the **root** of the ZIP file. Do not zip the `src/` folder itself from outside — zip its *contents*.
29-
30-
### Step 2: Submit to Mozilla Add-on Developer Hub
31-
32-
1. Go to the [Mozilla Add-on Developer Hub](https://addons.mozilla.org/en-US/developers/)
33-
2. Sign in with your Firefox Account (or create one)
34-
3. Click **Submit a New Add-on**
35-
4. Choose **On your own** (self-hosted distribution)
36-
5. Upload the ZIP file
37-
6. Wait for automated validation. If it passes, click **Sign Add-on**
38-
39-
### Step 3: Download and Install
40-
41-
1. After signing, Mozilla provides a download link for the `.xpi` file
42-
2. Download the `.xpi` file
43-
3. Drag and drop it into a Firefox window
44-
4. Click **Add** when prompted
45-
46-
The extension is now permanently installed.
20+
| Issue | Solution |
21+
|-------|----------|
22+
| Extension doesn't activate | Make sure you have an OWA/Outlook tab open and are logged in |
23+
| No notifications appearing | Check Firefox notification permissions (Settings → Privacy & Security → Notifications) |
24+
| Folder scan returns empty | Navigate to the Mail view in OWA so the folder tree is visible |
4725

48-
## Alternative: Firefox Developer Edition / Nightly
26+
---
4927

50-
If you use **Firefox Developer Edition** or **Firefox Nightly**, you can bypass signing:
28+
## 🧪 Development / Testing (Optional)
5129

52-
1. Navigate to `about:config`
53-
2. Search for `xpinstall.signatures.required`
54-
3. Set it to `false`
55-
4. You can now install unsigned `.xpi` or `.zip` files directly
30+
These steps are intended for developers contributing to the extension or testing local changes.
5631

57-
> **Warning**: Disabling signature verification reduces security and is not recommended for general use.
32+
### Method 1: Temporary Installation (`about:debugging`)
5833

59-
## Troubleshooting
34+
1. Open Firefox and navigate to `about:debugging`
35+
2. Click **This Firefox** in the sidebar
36+
3. Click **Load Temporary Add-on...**
37+
4. Navigate to the `src/` directory of this project
38+
5. Select the `manifest.json` file
6039

61-
| Issue | Solution |
62-
|-------|----------|
63-
| Extension doesn't activate | Make sure you have an OWA/Outlook tab open and are logged in |
64-
| No notifications appearing | Check Firefox notification permissions (Settings → Privacy & Security → Notifications) |
65-
| Folder scan returns empty | Navigate to the Mail view in OWA so the folder tree is visible |
66-
| Extension removed after restart | You are using temporary mode — follow Method 2 for permanent installation |
40+
> **Note**: Temporary add-ons are removed when Firefox is closed.
6741
68-
## Using with `web-ext` (Developer Workflow)
42+
### Method 2: Using `web-ext`
6943

70-
If you have Node.js installed, you can use Mozilla's `web-ext` tool:
44+
If you have Node.js installed, you can use Mozilla's `web-ext` tool for live-reload development:
7145

7246
```bash
73-
npm install -g web-ext
74-
cd src/
75-
web-ext run
47+
npm install
48+
npm run start
49+
# (Runs: web-ext run --source-dir=src/)
7650
```
77-
78-
This launches Firefox with the extension loaded and provides live-reload during development.

0 commit comments

Comments
 (0)