File tree Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Expand file tree Collapse file tree 1 file changed +22
-1
lines changed Original file line number Diff line number Diff line change @@ -6,7 +6,8 @@ Quick start for HTML5 Boilerplate. Get up in running with one command.
6
6
7
7
## Getting Started
8
8
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 `
10
11
11
12
Using ` npx `
12
13
@@ -37,3 +38,23 @@ These commands are equivalent and do the following:
37
38
1 . Dowloads and installs the latest version of HTML5-Boilerplate
38
39
2 . Bundles site assets and tart a web server using [ ` parcel ` ] ( https://parceljs.org/ )
39
40
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
+ ```
You can’t perform that action at this time.
0 commit comments