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

# [plugin_name]

TODO: Describe the plugin.

## Example animated gif of usage if appropriate

![screenshot](https://user-images.githubusercontent.com/220864/99979953-97841d80-2d9f-11eb-9782-5f65817c58f4.PNG)

## Installation

From the Etherpad working directory, run:

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

Or, install from Etherpad's `/admin/plugins` page.

## Configuration

TODO

## Testing

To run the backend tests, run the following from the Etherpad working directory:

```shell
(cd src && npm test)
```

To run the frontend tests, visit: http://localhost:9001/tests/frontend/

## Copyright and License

Copyright © [yyyy] [name of copyright owner]
and the [plugin_name] authors and contributors

Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"); you
may not use this file except in compliance with the License. You may obtain a
copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.