Skip to content

Commit 7d3e87d

Browse files
committed
docs: add installation info; add consistent heading styles closes #226
1 parent 9ba2503 commit 7d3e87d

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@ node-static understands and supports *conditional GET* and *HEAD* requests.
66
node-static was inspired by some of the other static-file serving modules out
77
there, such as node-paperboy and antinode.
88

9-
# Synopsis
9+
## Installation
10+
11+
```sh
12+
$ npm install node-static
13+
```
14+
15+
## Synopsis
1016

1117
```js
1218
const statik = require('node-static');
@@ -26,8 +32,7 @@ require('http').createServer(function (request, response) {
2632
}).listen(8080);
2733
```
2834

29-
API
30-
---
35+
## API
3136

3237
### Creating a node-static Server
3338

@@ -217,8 +222,7 @@ example: `{ defaultExtension: "html" }`
217222
> Defaults to `null`
218223
219224

220-
Command Line Interface
221-
----------------------
225+
## Command Line Interface
222226

223227
`node-static` also provides a CLI.
224228

0 commit comments

Comments
 (0)