Skip to content

Commit 9f2fc66

Browse files
committed
added a new section for the npm install fallback
1 parent bdc8355 commit 9f2fc66

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Quick start for HTML5 Boilerplate. Get up in running with one command.
66

77
## Getting Started
88

9-
You can get started using one of three options- `npx`, `npm init`, or `yarn create`
9+
You can get started using one of three options- `npx`, `npm init`, or
10+
`yarn create`
1011

1112
Using `npx`
1213

@@ -37,3 +38,23 @@ These commands are equivalent and do the following:
3738
1. Dowloads and installs the latest version of HTML5-Boilerplate
3839
2. Bundles site assets and tart a web server using [`parcel`](https://parceljs.org/)
3940
3. Opens a web browser pointed to http://localhost:1234/
41+
42+
## Requirements
43+
44+
`create-html5-boilerplate` is cross-platform. It works whereever node and npm work.
45+
The only requirements are for `npx`, which requires npm version 5.2 or greater and
46+
`npm init` which requires an npm version greater than 6.0. If you're stuck on an
47+
older version of npm you can still use `create-html5-boilerplate` by running the
48+
following command to install the project globally.
49+
50+
```sh
51+
npm install -g create-html5-boilperlate
52+
```
53+
54+
Then you can use create-html5-boilerplate as in the following example
55+
56+
```sh
57+
create-html5-boilperlate new-site
58+
cd new-site
59+
npm start
60+
```

0 commit comments

Comments
 (0)