Skip to content

Commit 316299f

Browse files
committed
Merge branch 'master' of https://github.com/h5bp/create-html5-boilerplate into lang
2 parents 3e8c068 + 635ae3f commit 316299f

File tree

6 files changed

+149
-59
lines changed

6 files changed

+149
-59
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 0.1.0 (May 25, 2020)
2+
3+
- Initial Release

README.md

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,76 @@
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 and running with one command.
6+
7+
## Getting Started
8+
9+
You can get started using one of three options- `npx`, `npm init`, or
10+
`yarn create`
11+
12+
Using `npx`
13+
14+
```
15+
npx create-html5-boilerplate new-site
16+
cd new-site
17+
npm install
18+
npm start
19+
```
20+
21+
Using `npm init`
22+
23+
```
24+
npm init create-html5-boilerplate new-site
25+
cd new-site
26+
npm install
27+
npm start
28+
```
29+
30+
Using yarn
31+
32+
```
33+
yarn create html5-boilerplate new-site
34+
cd new-site
35+
yarn install
36+
yarn start
37+
```
38+
39+
These commands are equivalent and do the following:
40+
41+
1. Download and install the latest version of HTML5 Boilerplate
42+
2. Installs dependencies
43+
3. Bundles site assets and start a web server using [Parcel](https://parceljs.org/)
44+
4. Opens a web browser pointed to http://localhost:1234/
45+
46+
## Requirements
47+
48+
`create-html5-boilerplate` is cross-platform. It works wherever node and npm work.
49+
The only requirements are for `npx`, which requires npm version 5.2 or greater and
50+
`npm init` which requires an npm version greater than 6.0. If you're stuck on an
51+
older version of npm you can still use `create-html5-boilerplate` by running the
52+
following command to install the project globally.
53+
54+
```
55+
npm install -g create-html5-boilerplate
56+
```
57+
58+
Then you can use `create-html5-boilerplate` as in the following example
59+
60+
```
61+
create-html5-boilerplate new-site
62+
cd new-site
63+
npm install
64+
npm start
65+
```
66+
67+
## Installing Specific Versions
68+
69+
You can also install a specific version:
70+
71+
```
72+
npx create-html5-boilerplate new-site --release=7.2.0
73+
cd new-site
74+
npm install
75+
npm start
76+
```

index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
#!/usr/bin/env node
12
require("./lib/cli")().catch(console.error);

lib/cli.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
#!/usr/bin/env node
21
"use strict";
32
const yargs_parser = require("yargs-parser");
43
const path = require("path");

package-lock.json

Lines changed: 69 additions & 54 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "create-html5-boilerplate",
3-
"version": "0.0.1-RC1",
4-
"description": "",
3+
"version": "0.1.0",
4+
"description": "An npm based quickstart app for HTML5-Boilerplate",
55
"keywords": [],
66
"homepage": "https://html5boilerplate.com/",
77
"bugs": {

0 commit comments

Comments
 (0)