Skip to content

A free and open-source block-based email template builder.

Updating READMEs with basic self-hosting instructions (#75)

Jordan Isip1fa51d4f33d0
diff --git a/README.md b/README.md
index d586f3f..8bf27a4 100644
--- a/README.md
+++ b/README.md
@@ -204,7 +204,7 @@ await axios({
## Self hosting the Editor
-A self-hosted version of the editor is coming soon. In the mean time you can use the packages/sample-editor as an example.
+You can fork this repository and use [packages/editor-sample](https://github.com/usewaypoint/email-builder-js/tree/main/packages/editor-sample) as an example. View the README file to see how to run it locally.
---
diff --git a/packages/editor-sample/README.md b/packages/editor-sample/README.md
index 37255c7..a9ad8b0 100644
--- a/packages/editor-sample/README.md
+++ b/packages/editor-sample/README.md
@@ -1 +1,10 @@
# @usewaypoint/editor-sample
+
+Use this as a sample to self-host EmailBuilder.js.
+
+To run this locally, fork the repository and then in this directory run:
+
+- `npm install`
+- `npx vite`
+
+Once the server is running, open http://localhost:5173/email-builder-js/ in your browser.