dnrops
/
serve
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): add note about using node 14+ (#715)

This commit is contained in:
Vedant K 2022-07-18 06:21:28 +05:30 committed by GitHub
parent 59e6b000d5
commit f8abc37125
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@ -26,6 +26,8 @@
## Usage
> `serve` v14 onwards requires Node v14 to run. Please use `serve` v13 if you cannot upgrade to Node v14.
The quickest way to get started is to just run `npx serve` in your project's directory.
If you prefer, you can also install the package globally (you'll need at least [Node LTS](https://github.com/nodejs/Release#release-schedule)):
@ -60,7 +62,7 @@ To customize `serve`'s behavior, create a `serve.json` file in the public folder
## API
The core of `serve` is [serve-handler](https://github.com/vercel/serve-handler), which can be used as middleware in existing HTTP servers:
The core of `serve` is [`serve-handler`](https://github.com/vercel/serve-handler), which can be used as middleware in existing HTTP servers:
```js
const handler = require('serve-handler');
@ -77,9 +79,7 @@ server.listen(3000, () => {
});
```
> **Note**
>
> You can also replace `http.createServer` with [micro](https://github.com/vercel/micro).
> You can also replace `http.createServer` with [`micro`](https://github.com/vercel/micro).
## Issues and Contributing
@ -89,7 +89,7 @@ If you wish to contribute to the project, please read the [contributing guide](c
## Credits
This project used to be called "list" and "micro-list". But thanks to [TJ Holowaychuk](https://github.com/tj) handing us the new name, it's now called "serve" (which is much more definite).
This project used to be called `list` and `micro-list`. But thanks to [TJ Holowaychuk](https://github.com/tj) handing us the new name, it's now called `serve` (which is much more definite).
## Author