Skip to content

Commit 23db458

Browse files
authored
Update README.md
1 parent 3198e3c commit 23db458

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,7 @@ If this sounds confusing, support is available through [our regular channels](ht
2323
### When to use Netlify Dev or `netlify-lambda` or both?
2424

2525
<details>
26-
<summary>
27-
28-
29-
[`Netlify Dev`](https://github.com/netlify/netlify-dev-plugin#what-is-netlify-dev) is incrementally adoptable. **Use `netlify-lambda` only if you need a build step for your functions**
30-
31-
</summary>
32-
26+
<summary><a href="https://github.com/netlify/netlify-dev-plugin#what-is-netlify-dev">Netlify Dev</a> is incrementally adoptable. <b>Use `netlify-lambda` only if you need a build step for your functions.</b> Expand this to read more on when to use either or both</summary>
3327

3428

3529
- **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.
@@ -67,9 +61,11 @@ If you don't have a [`netlify.toml`](https://www.netlify.com/docs/netlify-toml-r
6761
We expose three commands:
6862

6963
```bash
70-
netlify-lambda serve <folder>
7164
netlify-lambda build <folder>
7265
netlify-lambda install [folder]
66+
67+
## legacy command - only preserved for backward compatibility
68+
netlify-lambda serve <folder>
7369
```
7470

7571
### `netlify-lambda install`
@@ -169,11 +165,11 @@ export async function handler(event, context) {
169165

170166
</details>
171167

172-
### `netlify-lambda serve`
168+
### `netlify-lambda serve` (legacy command)
173169

174170
This command is pretty much superceded by Netlify Dev. We only keep it around for legacy/backward compatibility support reasons.
175171

176-
#### `netlify-lambda serve`: Using with `create-react-app`, Gatsby, and other development servers
172+
#### `netlify-lambda serve` (legacy command): Using with `create-react-app`, Gatsby, and other development servers
177173

178174
<details>
179175
<summary><b>Why you need to proxy (for beginners)</b></summary>
@@ -186,7 +182,7 @@ If this desribes your situation, then you need to proxy for local development. R
186182

187183
</details>
188184

189-
#### `netlify-lambda serve`: Proxying for local development
185+
#### `netlify-lambda serve` (legacy command): Proxying for local development
190186

191187
> ⚠️IMPORTANT! PLEASE READ THIS ESPECIALLY IF YOU HAVE CORS ISSUES⚠️
192188
@@ -548,6 +544,8 @@ All of the above are community maintained and not officially supported by Netlif
548544
- v1.2: https://twitter.com/swyx/status/1083446733374337024 Identity emulation (& others)
549545
- v1.3: https://github.com/netlify/netlify-lambda/releases/tag/v1.3.0
550546
- v1.4: New timeout feature https://github.com/netlify/netlify-lambda/pull/116
547+
- v1.5: Catch raw requests - a very common error for first time users pinging `localhost:9000` instead of `localhost:9000/.netlify/functions/myfunction` https://github.com/netlify/netlify-lambda/commit/bfebc0921a45d4f730b910b680e40e04928f7c29#diff-3288939317efd62bfc509440d662cacaR191
548+
- v1.6: New `install` command https://mobile.twitter.com/swyx/status/1162038490298818562
551549

552550
## License
553551

0 commit comments

Comments
 (0)