aboutsummaryrefslogtreecommitdiffstats
path: root/firefox-addon/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'firefox-addon/README.rst')
-rw-r--r--firefox-addon/README.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/firefox-addon/README.rst b/firefox-addon/README.rst
new file mode 100644
index 0000000..c452635
--- /dev/null
+++ b/firefox-addon/README.rst
@@ -0,0 +1,12 @@
+This Firefox add-on is available here__ on the Mozilla Add-Ons Website.
+
+To build and install from the source code, you need to:
+
+* install and activate the Add-on SDK as explained here__.
+* use ``cfx run`` in this folder to launch an instance of Firefox with the
+ add-on enabled.
+* use ``cfx xpi`` in this folder to package the add-on as an XPI file that
+ you can then install at ``about:addons``
+
+__ https://addons.mozilla.org/en-US/firefox/addon/browsing-activity-tracker/
+__ https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation