@sveltejs/vite-plugin-svelte 1.0.0-next.9 → 1.0.2

package/README.md

@@ -1,62 +1,28 @@
 # @sveltejs/vite-plugin-svelte
 
-## usage
+The official [Svelte](https://svelte.dev) plugin for [Vite](https://vitejs.dev).
+
+## Usage
 
 ```js
 // vite.config.js
-const svelte = require('@sveltejs/vite-plugin-svelte');
-const { defineConfig } = require('vite');
-
-module.exports = defineConfig(({ command, mode }) => {
-	const isProduction = mode === 'production';
-	return {
-		plugins: [
-			svelte({
-				/* inline options here */
-			})
-		],
-		build: {
-			minify: isProduction
-		}
-	};
+import { defineConfig } from 'vite';
+import { svelte } from '@sveltejs/vite-plugin-svelte';
+
+export default defineConfig({
+  plugins: [
+    svelte({
+      /* plugin options */
+    })
+  ]
 });
 ```
 
-## Options
-
-vite-plugin-svelte reads the vite configuration and uses an appropriate default configuration
-
-It also loads `svelte.config.js` (or `svelte.config.cjs`) from the configured `vite.root` directory automatically.
-
-Options are applied in the following order:
-
-1. vite-plugin-svelte defaults
-2. svelte.config.js in vite.root
-3. inline options passed in vite.config.js
-
-It supports all options from rollup-plugin-svelte and some additional options to tailor the plugin to your needs.
-
-For more Information check [options.ts](src/utils/options.ts)
-
-## Integrations for other vite plugins
-
-### Add an extra preprocessor
-
-vite-plugin-svelte uses the svelte compiler to split `.svelte` files into js and css and the svelte compiler requires that the css passed to it is already plain css.
-If you are building a plugin for vite that transforms css and want it to work out of the box with vite-plugin-svelte, you can add a `sveltePreprocess: PreprocessorGroup` to your vite plugin definition and vite-plugin-svelte will pick it up and add it to the list of svelte preprocessors used at runtime.
-
-```js
-const vitePluginCoolCss = {
-	name: 'vite-plugin-coolcss',
-	sveltePreprocess: {
-		/* your PreprocessorGroup here */
-	}
-	/*... your cool css plugin implementation here .. */
-};
-```
+## Documentation
 
-Check out [windicss](https://github.com/windicss/vite-plugin-windicss/blob/517eca0cebc879d931c6578a08accadfb112157c/packages/vite-plugin-windicss/src/index.ts#L167)
+- [Plugin options](../../docs/config.md)
+- [FAQ](../../docs/faq.md)
 
 ## License
 
-MIT
+[MIT](./LICENSE)