Adjust repository layout for NotificationBox

thunderbird · Aug 7, 2024 · 3ff9a74 · 3ff9a74
1 parent 48d91f5
commit 3ff9a74
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/...tionBox/NotificationBox/implementation.js → ...icationBox/parent/ext-notification-box.js b/...tionBox/NotificationBox/implementation.js → ...icationBox/parent/ext-notification-box.js
diff --git a/NotificationBox/NotificationBox/schema.json → ...ificationBox/schema/notification-box.json b/NotificationBox/NotificationBox/schema.json → ...ificationBox/schema/notification-box.json
diff --git a/NotificationBox/manifest.json b/NotificationBox/manifest.json
@@ -26,11 +26,11 @@
   },
   "experiment_apis": {
     "NotificationBox": {
-      "schema": "NotificationBox/schema.json",
+      "schema": "experiments/NotificationBox/schema/notification-box.json",
       "parent": {
         "scopes": ["addon_parent"],
         "paths": [["NotificationBox"]],
-        "script": "NotificationBox/implementation.js"
+        "script": "experiments/NotificationBox/parent/ext-notification-box.js"
       }
     }
   }

diff --git a/README.md b/README.md
@@ -99,6 +99,19 @@ official [communication channels](https://developer.thunderbird.net/add-ons/comm
 to tell you more about how they work, and engage in some ad-hoc discussion on how to design WebExtension
 APIs.
 
+Using experiments in your add-ons
+---------------------------------
+
+The repository layout is conveniently written so you can collect the experiments in a subdirectory of your add-on.
+
+```
+mkdir -p my_addon_directory/experiments
+cp -R webext-experiments/calendar/experiments/ my_addon_directory/experiments
+```
+
+Now copy the respective `experiment_apis` entries in e.g. `calendar/manifest.json` to your add-on's manifest.json.
+
+
 Migrating from Legacy Add-ons
 -----------------------------
 If you are migrating your legacy add-on to WebExtensions, you may need to rethink how your UI is