Merge branch 'master' of https://github.com/h5bp/create-html5-boilerp…

…late into lang

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (May 25, 2020)
+
+- Initial Release

README.md

@@ -1,4 +1,76 @@
-# create-html5-boilerplate
-npx for html5-boilerplate
+# Create HTML5 Boilerplate
 
 [![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)
+
+Quick start for HTML5 Boilerplate. Get up and running with one command.
+
+## Getting Started
+
+You can get started using one of three options- `npx`, `npm init`, or
+`yarn create`
+
+Using `npx`
+
+```
+npx create-html5-boilerplate new-site
+cd new-site
+npm install
+npm start
+```
+
+Using `npm init`
+
+```
+npm init create-html5-boilerplate new-site
+cd new-site
+npm install
+npm start
+```
+
+Using yarn
+
+```
+yarn create html5-boilerplate new-site
+cd new-site
+yarn install
+yarn start
+```
+
+These commands are equivalent and do the following:
+
+1. Download and install the latest version of HTML5 Boilerplate
+2. Installs dependencies
+3. Bundles site assets and start a web server using [Parcel](https://parceljs.org/)
+4. Opens a web browser pointed to http://localhost:1234/
+
+## Requirements
+
+`create-html5-boilerplate` is cross-platform. It works wherever node and npm work.
+The only requirements are for `npx`, which requires npm version 5.2 or greater and
+`npm init` which requires an npm version greater than 6.0. If you're stuck on an
+older version of npm you can still use `create-html5-boilerplate` by running the
+following command to install the project globally.
+
+```
+npm install -g create-html5-boilerplate
+```
+
+Then you can use `create-html5-boilerplate` as in the following example
+
+```
+create-html5-boilerplate new-site
+cd new-site
+npm install
+npm start
+```
+
+## Installing Specific Versions
+
+You can also install a specific version:
+
+```
+npx create-html5-boilerplate new-site --release=7.2.0
+cd new-site
+npm install
+npm start
+```

index.js

@@ -1 +1,2 @@
+#!/usr/bin/env node
 require("./lib/cli")().catch(console.error);

lib/cli.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 const yargs_parser = require("yargs-parser");
 const path = require("path");

package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-html5-boilerplate",
-  "version": "0.0.1-RC1",
-  "description": "",
+  "version": "0.1.0",
+  "description": "An npm based quickstart app for HTML5-Boilerplate",
   "keywords": [],
   "homepage": "https://html5boilerplate.com/",
   "bugs": {