Skip to content

Commit

Permalink
docs(readme): add note about using node 14+ (#715)
Browse files Browse the repository at this point in the history
  • Loading branch information
gamemaker1 authored Jul 18, 2022
1 parent 59e6b00 commit f8abc37
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)):
Expand Down Expand Up @@ -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');
Expand All @@ -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

Expand All @@ -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

Expand Down

0 comments on commit f8abc37

Please sign in to comment.