Provide a README.md with all relevant installation and usage information

Created on 29 January 2024, 10 months ago

Problem/Motivation

3.x needs a README.md which informs a user about all the relevant steps and how to use this module, e.g.
- Installation
- Local library download (drush, composer)
- CDN library usage
- Use with VueJS 2 (see separate issue)
- How to add this module's libraries in a dependent module
- Example code how to use VueJS with this module in a dependent module

+ Further standard README.md information

Steps to reproduce

Proposed resolution

Provide the README with all the information as proposed based on the Drupal.org README.md template.
Update the module page with that information for 3.x

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Active

Version

3.0

Component

Documentation

Created by

🇩🇪Germany Anybody Porta Westfalica

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024