@sveltejs/adapter-netlify 1.0.0-next.36 → 1.0.0-next.37

package/README.md

@@ -1,8 +1,6 @@
 # adapter-netlify
 
-Adapter for Svelte apps that creates a Netlify app, using a function for dynamic server rendering. A future version might use a function per route, though it's unclear if that has any real advantages.
-
-This is very experimental; the adapter API isn't at all fleshed out, and things will definitely change.
+Adapter for Svelte apps that creates a Netlify app, using serverless functions for dynamically generating pages.
 
 ## Installation
 
@@ -19,7 +17,11 @@ import adapter from '@sveltejs/adapter-netlify';
 
 export default {
 	kit: {
-		adapter: adapter(), // currently the adapter does not take any options
+		adapter: adapter({
+			// if true, will split your app into multiple functions
+			// instead of creating a single one for the entire app
+			split: false
+		}),
 		target: '#svelte'
 	}
 };
@@ -41,7 +43,7 @@ You may build your app using functionality provided directly by SvelteKit withou
 
 ### Using Netlify Redirect Rules
 
-During compilation a required "catch all" redirect rule is automatically appended to your `_redirects` file. (If it doesn't exist yet, it will be created.) That means:
+During compilation, redirect rules are automatically appended to your `_redirects` file. (If it doesn't exist yet, it will be created.) That means:
 
 - `[[redirects]]` in `netlify.toml` will never match as `_redirects` has a [higher priority](https://docs.netlify.com/routing/redirects/#rule-processing-order). So always put your rules in the [`_redirects` file](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file).
 - `_redirects` shouldn't have any custom "catch all" rules such as `/* /foobar/:splat`. Otherwise the automatically appended rule will never be applied as Netlify is only processing [the first matching rule](https://docs.netlify.com/routing/redirects/#rule-processing-order).
@@ -66,38 +68,6 @@ During compilation a required "catch all" redirect rule is automatically appende
   node_bundler = "esbuild"
 ```
 
-## Advanced Configuration
-
-### esbuild
-
-As an escape hatch, you may optionally specify a function which will receive the final esbuild options generated by this adapter and returns a modified esbuild configuration. The result of this function will be passed as-is to esbuild. The function can be async.
-
-For example, you may wish to add a plugin:
-
-```js
-adapterNetlify({
-	esbuild(defaultOptions) {
-		return {
-			...defaultOptions,
-			plugins: []
-		};
-	}
-});
-```
-
-The default options for this version are as follows:
-
-```js
-{
-	entryPoints: ['.svelte-kit/netlify/entry.js'],
-	// This is Netlify's internal functions directory, not the one for user functions.
-	outfile: '.netlify/functions-internal/__render.js',
-	bundle: true,
-	inject: ['pathTo/shims.js'],
-	platform: 'node'
-}
-```
-
 ## Changelog
 
 [The Changelog for this package is available on GitHub](https://github.com/sveltejs/kit/blob/master/packages/adapter-netlify/CHANGELOG.md).