Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information about how to serve a specific path #548

Merged
merged 4 commits into from Sep 26, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
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
Expand Up @@ -59,6 +59,7 @@ const getHelp = () => chalk`

{bold $} {cyan serve} --help
{bold $} {cyan serve} --version
{bold $} {cyan serve} folder_path
{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 @@ -82,7 +83,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