felixfoertsch/webextensions-examples
1
0
Fork 0
mirror of https://github.com/mdn/webextensions-examples.git synced 2026-04-17 14:59:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated README, following @ddbeck's checklist

Browse Source
This commit is contained in:
Will Bamberg
2016-05-31 15:36:35 -07:00
parent 2a5c590c4e
commit 6f75964d17
1 changed files with 44 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -1,11 +1,48 @@
# webextensions-examples
Example Firefox add-ons created using the [WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) API.
To use these examples, you need at least Firefox 45. Some examples rely on
APIs that were added in more recent versions of Firefox. To check the minimum
version of Firefox needed for a given example, see the `strict_min_version`
part of the [applications key](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/applications) in the example's manifest.json file.
[https://github.com/mdn/webextensions-examples](https://github.com/mdn/webextensions-examples)
To test out an extension in Firefox, see [Packaging and Installation](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Packaging_and_installation).
Maintained by the [MDN team at Mozilla](https://wiki.mozilla.org/MDN).
To see details of each extension, what it does and what it demonstrates, see the [WebExtensions Examples page](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Examples).
WebExtensions are a way to write browser extensions. They use a set of
cross-browser APIs: WebExtensions written for Google Chrome or Opera will
in most cases run in Firefox or Edge too.
The "webextensions-examples" repository is a collection of simple but complete
and installable WebExtensions. You can use the examples to see how to use the
WebExtensions APIs, and as a starting point for your own WebExtensions.
The examples are made available under the
[Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/).
## How to use "webextensions-examples"
To use the repository, clone it, install the examples in your favourite
browser (see [installation instructions for Firefox](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Packaging_and_installation)),
and see how they work. Each example has its own short README explaining what
it does.
To use these examples in Firefox, you need at least Firefox 45. Some examples
rely on APIs that were added in more recent versions of Firefox.
To check the minimum version of Firefox needed for a given example,
see the `strict_min_version` part of the [applications key](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/applications)
in the example's manifest.json file.
## Learn more
To learn more about developing WebExtensions, see the
[WebExtensions documentation on MDN](https://developer.mozilla.org/en-US/Add-ons/WebExtensions)
for getting started guides, tutorials, and full API reference docs.
## Problems?
If you find a problem, please [file a bug](https://github.com/mdn/webextensions-examples/issues/new).
If you need help, email the [dev-addons mailing list](https://mail.mozilla.org/listinfo/dev-addons) or contact the WebExtensions team in the #webextensions IRC channel on irc.mozilla.org.
## Contributing
We welcome contributions, whether they are whole new examples, new features,
bug fixes, or translations of localizable strings into new languages. Please
see the [CONTRIBUTING.md](https://github.com/mdn/webextensions-examples/blob/master/CONTRIBUTING.md) file for more details.