diff --git a/README.md b/README.md index d7fdefe..c137219 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,3 @@ -# Svelte library +# Jitsi iFrame Svelte Integration -Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv). - -Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging). - -## Creating a project - -If you're seeing this, you've probably already done this step. Congrats! - -```sh -# create a new project in the current directory -npx sv create - -# create a new project in my-app -npx sv create my-app -``` - -To recreate this project with the same configuration: - -```sh -# recreate this project -pnpm dlx sv create --template library --types ts --add prettier eslint devtools-json --install pnpm jitsi -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```sh -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` - -Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app. - -## Building - -To build your library: - -```sh -npm pack -``` - -To create a production version of your showcase app: - -```sh -npm run build -``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. - -## Publishing - -Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)). - -To publish your library to [npm](https://www.npmjs.com): - -```sh -npm publish -``` +This package provides a component and typed API for the Jitsi Meet iFrame. If you prefer to build your own component, refer directly to the exported type definitions for the Jitsi iFrame API.