Skip to content

Commit

Permalink
Add information about how to serve a specific path (#548)
Browse files Browse the repository at this point in the history
* Add information about how to serve a specific path

* Fixed usage

* Fixed description

* Fixed name
  • Loading branch information
Johann-S authored and leo committed Sep 26, 2019
1 parent 550a76e commit aa00e2c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,18 @@ If you prefer, you can also install the package globally using [Yarn](https://ya
yarn global add serve
```

Once that's done, you can run this command inside your project's directory:
Once that's done, you can run this command inside your project's directory...

```bash
serve
```

...or specify which folder you want to serve:

```bash
serve folder_name
```

Finally, run this command to see a list of all available options:

```bash
Expand Down
3 changes: 2 additions & 1 deletion bin/serve.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ const getHelp = () => chalk`
{bold $} {cyan serve} --help
{bold $} {cyan serve} --version
{bold $} {cyan serve} folder_name
{bold $} {cyan serve} [-l {underline listen_uri} [-l ...]] [{underline directory}]
By default, {cyan serve} will listen on {bold 0.0.0.0:5000} and serve the
Expand All @@ -83,7 +84,7 @@ const getHelp = () => chalk`
-c, --config Specify custom path to \`serve.json\`
-n, --no-clipboard Do not copy the local address to the clipboard
-u, --no-compression Do not compress files
--no-etag Send \`Last-Modified\` header instead of \`ETag\`
Expand Down

0 comments on commit aa00e2c

Please sign in to comment.