Files
chrome-extensions-samples/README-template.md
Joe Medley ee11d4ac5b Add a README template and instructions to use it. (#866)
* Add README template.

* Formatting

* Add README instructions and link to CONTRIBUTING.
2023-03-27 08:19:13 -07:00

758 B

To create a README for your sample

  1. Copy this file to your sample folder.
  2. Enter the requested information below.
  3. Delete all intructions.

For API samples use the name of the API. For example, a sample about the chrome.declarativeNetRequest would simply be called "chrome.declarativeNetRequest". (Do not use special formatting in headings.) For functional samples, the title should be what the sample demonstrates

Title

Describe what the sample demonstrates. If this is an API sample, link to the API.

This sample demonstrates ...

Overview

Describe how the sample demonstrates the API or use case and briefly describe how to use it.

Implementation Notes

Add any information that doesn't fit elsewhere in the README.