diff --git a/sites/docs/content/get-started.md b/sites/docs/content/get-started.md index 03c629e..744cd85 100644 --- a/sites/docs/content/get-started.md +++ b/sites/docs/content/get-started.md @@ -5,11 +5,46 @@ tagline: Guide --- - + -The documentation is still a work in progress. Please refer to the [GitHub README](https://github.com/svecosystem/mode-watcher) for more information. +Install the package - +Install the `mode-watcher` package from npm. + +```bash +npm install mode-watcher +``` + +Add the ModeWatcher component + +Add the `` component to your root `+layout.svelte` file. + +```svelte {2,5}#add title="src/routes/+layout.svelte" + + + + +``` + +That's it! + +You're now ready to use Mode Watcher in your Svelte app. + +Here's an example of how to use the `toggleMode` function to toggle the mode: + +```svelte title="src/lib/components/light-switch.svelte" + + + +``` + +For additional information and configuration, please refer to the [API reference](/docs/api-reference/mode-watcher). + +