From 4ef313259424f22d89f7f2bdfe185832ca979fe4 Mon Sep 17 00:00:00 2001 From: swyx Date: Tue, 9 Apr 2019 16:06:52 -0400 Subject: [PATCH] tweak netlify dev info --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 35c38fd8..d3ae31e6 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,12 @@ If this sounds confusing, support is available through [our regular channels](ht
Netlify Dev vs. Netlify-Lambda -Some headline notes: +[`Netlify Dev`](https://github.com/netlify/netlify-dev-plugin#what-is-netlify-dev) is incrementally adoptable. **`netlify-lambda` is still recommended if you need a build step for your functions**, as explained here: -- [`Netlify Dev`](https://github.com/netlify/netlify-dev-plugin#what-is-netlify-dev) is incrementally adoptable. **`netlify-lambda` is not deprecated and is still recommended for some situations**, as explained below. -- Part of Netlify Dev serves unbundled function folders through [zip-it-and-ship-it](https://github.com/netlify/zip-it-and-ship-it) with no build step. This is likely to be attractive to many users who previously needed `netlify-lambda` for function folders. -- However, if you want to use a build step for your functions (e.g. for webpack import/export, babel or typescript), you can use `netlify-lambda`, `tsc` or your own build tool to do this, just point Netlify Dev at your build output with the `functions` field in `netlify.toml`. +- **When to use Netlify Dev**: Part of Netlify Dev serves unbundled function folders through [zip-it-and-ship-it](https://github.com/netlify/zip-it-and-ship-it) with no build step. This is likely to be attractive to many users who previously just needed `netlify-lambda` for bundling multi-file functions or functions with node_module dependencies. +- **When to use Netlify Lambda**: However, if you need a build step for your functions (e.g. for webpack import/export syntax, running babel transforms or typescript), you can use `netlify-lambda`, `tsc` or your own build tool to do this, just point Netlify Dev at your build output with the `functions` field in `netlify.toml`. - Finally, We also want **existing `netlify-lambda` users to be able to use Netlify Dev with no change to their workflow**. This is done through the [Netlify Dev Function Builder](https://github.com/netlify/netlify-dev-plugin#function-builders-function-builder-detection-and-relationship-with-netlify-lambda) abstraction. It is, however, a very new feature with only simple detection logic for now, that we aim to improve over time. If it doesn't work well for you, you can simply not use Netlify Dev for now while we work out all your bug reports. -