summaryrefslogtreecommitdiffstats
path: root/addon-sdk/source/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'addon-sdk/source/README.md')
-rw-r--r--addon-sdk/source/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/addon-sdk/source/README.md b/addon-sdk/source/README.md
new file mode 100644
index 000000000..4efa86dae
--- /dev/null
+++ b/addon-sdk/source/README.md
@@ -0,0 +1,34 @@
+# Mozilla Add-on SDK [![Build Status](https://travis-ci.org/mozilla/addon-sdk.png)](https://travis-ci.org/mozilla/addon-sdk)
+
+We suggest that developers of new add-ons [should look at using WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions).
+
+Using the Add-on SDK you can create Firefox add-ons using standard Web technologies: JavaScript, HTML, and CSS. The SDK includes JavaScript APIs which you can use to create add-ons, and tools for creating, running, testing, and packaging add-ons.
+
+If you find a problem, please [report the bug here](https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK).
+
+## Developing Add-ons
+
+These resources offer some help:
+
+* [Add-on SDK Documentation](https://developer.mozilla.org/en-US/Add-ons/SDK)
+* [Community Developed Modules](https://github.com/mozilla/addon-sdk/wiki/Community-developed-modules)
+* [Jetpack FAQ](https://wiki.mozilla.org/Jetpack/FAQ)
+* [StackOverflow Questions](http://stackoverflow.com/questions/tagged/firefox-addon-sdk)
+* [Mailing List](https://wiki.mozilla.org/Jetpack#Mailing_list)
+* #jetpack on irc.mozilla.org
+
+## Contributing Code
+
+Please read these two guides if you wish to make some patches to the addon-sdk:
+
+* [Contribute Guide](https://github.com/mozilla/addon-sdk/blob/master/CONTRIBUTING.md)
+* [Style Guide](https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide)
+
+## Issues
+
+We use [bugzilla](https://bugzilla.mozilla.org/) as our issue tracker, here are some useful links:
+
+* [File a bug](https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK)
+* [Open bugs](https://bugzilla.mozilla.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=bug_severity%2Cpriority%2Cassigned_to%2Cbug_status%2Ctarget_milestone%2Cresolution%2Cshort_desc%2Cchangeddate&product=Add-on%20SDK&query_format=advanced&order=priority)
+* [Good first bugs](https://bugzilla.mozilla.org/buglist.cgi?status_whiteboard=[good+first+bug]&&resolution=---&product=Add-on+SDK)
+* [Good next bugs](https://bugzilla.mozilla.org/buglist.cgi?status_whiteboard=[good+next+bug]&&resolution=---&product=Add-on+SDK)