From 3959061fea3c0a9fde8df59c9f91018fb4cefcc6 Mon Sep 17 00:00:00 2001 From: umaranis Date: Fri, 14 Jun 2024 07:58:57 +1000 Subject: [PATCH] docs: getting started --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 4d69ebe..f4739b8 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,21 @@ Lexical is an extensible text editor framework developed by awesome developers a ![Screenshot-Svelte-Lexical](docs/images/Screenshot-Svelte-Lexical.jpg) +## Getting Started + +Pick one of the demo projects to understand how `svelte-lexical` can be incorporated into your project. For instance, use `demos/sveltekit` for a SvelteKit and `demos/playground` for Svelte. + +To run the demo project: + +- First build `svelte-lexical` library + - change directory: `cd packages/svelte-lexical` + - install dependencies: `pnpm i` + - build the lib: `pnpm build` +- Run the demo project + - change directory: `cd ../../demos/playground` + - run dev: `pnpm dev` + + ## Development Notes - This project is set up as a monorepo using pnpm workspaces.