etherpad-lite/src/bin/plugins/lib/README.md

My awesome plugin README example

Explain what your plugin does and who it's useful for.

Example animated gif of usage if appropriate

Installing

npm install --no-save --legacy-peer-deps [plugin_name]

or Use the Etherpad /admin interface.

Settings

Document settings if any

Testing

Document how to run backend / frontend tests.

Frontend

Visit http://whatever/tests/frontend/ to run the frontend tests.

backend

Type cd src && npm run test to run the backend tests.

LICENSE

Apache 2.0