Merge branch 'master' of https://github.com/h5bp/create-html5-boilerplate into lang

Author: vltansky

.github/workflows/coveralls.yml

@@ -5,29 +5,38 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [12.x]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run coverage
+      - name: Get npm cache directory
+        id: npm-cache
+        run: |
+          echo "::set-output name=dir::$(npm config get cache)"
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.npm-cache.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run coverage
 
-    - name: Coveralls
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -74,3 +74,32 @@ cd new-site
 npm install
 npm start
 ```
+
+## CONTRIBUTING
+
+### Setting Up a Local Copy
+
+1. Clone the repo with `git clone https://github.com/h5bp/create-html5-boilerplate.git`
+2. Run `npm install` in the root `create-html5-boilerplate` folder.
+3. Run `npm link` to make npm run local copy instead of downloading from registry
+4. Now you can use `npm init html5-boilerplate` and `npx create-html5-boilerplate`
+
+note: you can use `npx create-html5-boilerplate ./out/example` from `create-html5-boilerplate` without running `npm link`
+also its possible to run directly NodeJS entry point `node index.js ./out/example` or `npm start`
+`./out` is git ignored folder, so you should use this folder for tests.
+
+If you want to try out the end-to-end flow with the global CLI, you can do this too:
+
+```
+npx create-html5-boilerplate ./out/new-site
+cd new-site
+npm install
+npm start
+```
+
+### Tests
+
+Tests are written using [jest](https://jestjs.io/) and located in `tests/test.js`
+run `npm test`
+
+run coverage reports `npm run coverage`

package.json

@@ -20,8 +20,7 @@
   "scripts": {
     "test": "jest",
     "format": "prettier --write \"./cli.js\" \"tests/*.js\"",
-    "coverage": "jest --coverage --collectCoverageOnlyFrom ./lib/cli.js",
-    "start": "node ./index.js ./out"
+    "coverage": "jest --coverage --collectCoverageOnlyFrom ./lib/cli.js"
   },
   "files": [
     "lib/**/*",