etherpad-lite/src/bin/plugins/lib
Richard Hansen 8eb310854d lint: Bump ESLint dependencies 2022-02-21 14:36:58 -05:00
..
CONTRIBUTING.md restructure: Prefix `bin/` and `tests/` with `src/` 2021-02-05 21:52:08 +00:00
LICENSE checkPlugin: Redo README.md and LICENSE 2021-12-11 02:01:35 -05:00
README.md checkPlugin: Redo README.md and LICENSE 2021-12-11 02:01:35 -05:00
backend-tests.yml ci: Reformat `.yml` files for readability 2022-01-28 01:39:45 -05:00
dependabot.yml ci: dependabot: Set `versioning-strategy` to `increase` 2022-01-27 23:54:28 -05:00
eslintrc.cjs lint: Bump ESLint dependencies 2022-02-21 14:36:58 -05:00
frontend-tests.yml ci: Skip frontend tests for Dependabot PRs 2022-01-28 01:51:15 -05:00
gitignore plugins: Don't create `.ep_initialized` files 2021-11-13 17:43:33 -05:00
npmpublish.yml ci: Reformat `.yml` files for readability 2022-01-28 01:39:45 -05:00

README.md

[plugin_name]

TODO: Describe the plugin.

Example animated gif of usage if appropriate

screenshot

Installation

From the Etherpad working directory, run:

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:

(cd src && npm test)

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

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

Licensed under the Apache License, Version 2.0 (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.