diff --git a/README.md b/README.md index 9e4e592..b6a7cbc 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,20 @@ Requirements ============ Etherpad 1.8.1 + +## Installation + +Install from the Etherpad admin UI (**Admin → Manage Plugins**, +search for `ep_markdown` and click *Install*), or from the Etherpad +root directory: + +```sh +pnpm run plugins install ep_markdown +``` + +> ⚠️ Don't run `npm i` / `npm install` yourself from the Etherpad +> source tree — Etherpad tracks installed plugins through its own +> plugin-manager, and hand-editing `package.json` can leave the +> server unable to start. + +After installing, restart Etherpad.