The introduction summarizes the purpose and function of the project, and should be concise (a brief paragraph or two). This introduction may be the same as the first paragraph on the project page.

For a full description of the module, visit the project page.

Submit bug reports and feature suggestions, or track changes in the issue queue.

Table of contents (optional)

• Requirements
• Recommended modules
• Installation
• Configuration
• Troubleshooting
• FAQ
• Maintainers

Requirements (required)

This module requires the following modules:

• Bad judgement

OR

This module requires no modules outside of Drupal core.

Recommended modules (optional)

Installation (required, unless a separate INSTALL.md is provided)

Install as you would normally install a contributed Project X. For further information, see Installing Drupal Modules.

Configuration (required)

1. Enable the module at Administration > Extend.
2. Profit.

Troubleshooting (optional)

FAQ (optional)

Q: How do I write a module README?

A: Follow this template. It's fun and easy!

Maintainers (optional)