mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-23 00:46:16 -04:00
47 lines
1.2 KiB
Markdown
Executable file
47 lines
1.2 KiB
Markdown
Executable file
# [plugin_name]
|
|
|
|
TODO: Describe the plugin.
|
|
|
|
## Example animated gif of usage if appropriate
|
|
|
|
|
|
|
|
## 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 && pnpm test)
|
|
```
|
|
|
|
To run the frontend tests, visit: http://localhost:9002/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.
|