summaryrefslogtreecommitdiff
path: root/examples/framework-svelte
diff options
context:
space:
mode:
Diffstat (limited to 'examples/framework-svelte')
-rw-r--r--examples/framework-svelte/README.md35
1 files changed, 32 insertions, 3 deletions
diff --git a/examples/framework-svelte/README.md b/examples/framework-svelte/README.md
index 465863f72..deaf1da76 100644
--- a/examples/framework-svelte/README.md
+++ b/examples/framework-svelte/README.md
@@ -1,9 +1,38 @@
# Using Svelte with Astro
-```
+This example showcases Astro's built-in support for [Svelte](https://svelte.dev/).
+
+## Installation
+
+### Automatic
+
+Bootstrap your Astro project with this template!
+
+```shell
npm init astro -- --template framework-svelte
```
-This example showcases Astro's built-in support for [Svelte](https://svelte.dev/).
+### Manual
+
+To use Svelte components in your Astro project:
+
+1. Install `@astrojs/renderer-svelte`
+
+ ```shell
+ npm i @astrojs/renderer-svelte
+ ```
+
+2. Add `"@astrojs/renderer-svelte"` to your `renderers` in `astro.config.mjs`.
+
+ ```js
+ export default {
+ renderers: [
+ "@astrojs/renderer-svelte",
+ // optionally, others...
+ ]
+ }
+ ```
+
+## Usage
-No configuration is needed to enable Svelte support—just start writing Svelte components in `src/components`.
+Write your Svelte components as `.svelte` files in your project.
Moore <nate@astro.build> 2022-06-30Fix integration name (`prefetch` instead of `lit`) (#3778)Gravatar hippotastic 2-1/+6 2022-06-30[ci] update lockfile (#3771)Gravatar Fred K. Bot 1-114/+112 Co-authored-by: FredKSchott <FredKSchott@users.noreply.github.com> 2022-06-30Integration Docs Next Steps (#3677)Gravatar Dan Jutan 11-314/+666 * sitemap readme skeleton + first sections * Revert "sitemap readme skeleton + first sections" This reverts commit cc55b312b6dc95522645002806d63f32c33d1956. * sitemap readme skeleton + first sections * remove canonicalURL option from sitemap * add customPages option to readme * sitemap examples * partytown * deno run command * reference deno example * node readme * netlify & vercel readmes * note that telemetry is installed * telemetry is *enabled*, not installed * Update packages/integrations/vercel/README.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * Update packages/integrations/vercel/README.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * readme -> README * Update packages/integrations/deno/readme.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * Update packages/integrations/deno/readme.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * qualify they * Update packages/integrations/sitemap/README.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * Uppercase README names * Update packages/integrations/partytown/README.md Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> * imports -> import typo * update changeset Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> 2022-06-30[ci] formatGravatar tony-sull 1-2/+2 2022-06-30refactor to provide better cli error handling (#3768)Gravatar Fred K. Schott 2-43/+37 2022-06-30[ci] release (#3772)@astrojs/preact@0.3.1Gravatar Fred K. Bot 12-22/+23 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> 2022-06-30Added Cloudflare adapter to README.md (#3773)Gravatar Isaac McFadyen 1-0/+1 2022-06-30[ci] formatGravatar hippotastic 1-5/+4 2022-06-30Fix "Invalid hook call" warning (#3769)Gravatar hippotastic 2-9/+79 * Fix "Invalid hook call" warning * Fix eslint warnings * Apply code review suggestions 2022-06-29[ci] release (#3759)astro@1.0.0-beta.59@astrojs/telemetry@0.2.2@astrojs/preact@0.3.0Gravatar Fred K. Bot 42-121/+117 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> 2022-06-29[ci] formatGravatar FredKSchott 8-35/+36 2022-06-29manual lockfile update (#3751)Gravatar Fred K. Schott 3-2659/+2871 * lockfile update * update lockfile gen script * Update index.ts 2022-06-29add error event to telemetry (#3750)Gravatar Fred K. Schott 16-85/+270