Skip to content

Commit

Permalink
docs: getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
umaranis committed Jun 13, 2024
1 parent 58a0766 commit 3959061
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3959061

Please sign in to comment.