Skip to content

Commit bdc8355

Browse files
committed
Adds initial documentation to the readme
1 parent 67dd516 commit bdc8355

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,39 @@
1-
# create-html5-boilerplate
2-
npx for html5-boilerplate
1+
# Create HTML5 Boilerplate
32

43
[![Coverage Status](https://coveralls.io/repos/github/h5bp/create-html5-boilerplate/badge.svg?branch=master)](https://coveralls.io/github/h5bp/create-html5-boilerplate?branch=master)
4+
5+
Quick start for HTML5 Boilerplate. Get up in running with one command.
6+
7+
## Getting Started
8+
9+
You can get started using one of three options- `npx`, `npm init`, or `yarn create`
10+
11+
Using `npx`
12+
13+
```sh
14+
npx create-html5-boilperlate new-site
15+
cd new-site
16+
npm start
17+
```
18+
19+
Using `npm init`
20+
21+
```sh
22+
npm init create-html5-boilperlate new-site
23+
cd new-site
24+
npm start
25+
```
26+
27+
Using yarn
28+
29+
```sh
30+
yarn create html5-boilperlate new-site
31+
cd new-site
32+
npm start
33+
```
34+
35+
These commands are equivalent and do the following:
36+
37+
1. Dowloads and installs the latest version of HTML5-Boilerplate
38+
2. Bundles site assets and tart a web server using [`parcel`](https://parceljs.org/)
39+
3. Opens a web browser pointed to http://localhost:1234/

0 commit comments

Comments
 (0)