2020-11-02 17:13:24 +01:00
|
|
|
# My awesome plugin README example
|
|
|
|
Explain what your plugin does and who it's useful for.
|
|
|
|
|
|
|
|
## Example animated gif of usage if appropriate
|
2020-11-23 17:34:26 +01:00
|
|
|
![screenshot](https://user-images.githubusercontent.com/220864/99979953-97841d80-2d9f-11eb-9782-5f65817c58f4.PNG)
|
2020-11-02 17:13:24 +01:00
|
|
|
|
|
|
|
## Installing
|
2021-02-18 09:13:09 +01:00
|
|
|
|
|
|
|
```
|
2021-02-16 01:10:55 +01:00
|
|
|
npm install --no-save --legacy-peer-deps [plugin_name]
|
2021-02-18 09:13:09 +01:00
|
|
|
```
|
2020-11-02 17:13:24 +01:00
|
|
|
|
|
|
|
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
|