Merge pull request #6 from form8ion/alpha

Initial release

Author: travi

.github/workflows/node-ci.yml

@@ -29,8 +29,27 @@ jobs:
       - run: npm test
       - name: Upload coverage data to Codecov
         run: npm run coverage:report
+  verify-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node:
+          - '12.20'
+          - 12
+          - 14
+          - 16
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - uses: bahmutov/npm-install@v1
+      - run: npm test
   release:
-    needs: verify
+    needs:
+      - verify
+      - verify-matrix
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

README.md

@@ -5,6 +5,7 @@ form8ion plugin for managing tools related to commit conventions
 <!--status-badges start -->
 
 [![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
+[![Codecov][coverage-badge]][coverage-link]
 
 <!--status-badges end -->
 
@@ -13,6 +14,8 @@ form8ion plugin for managing tools related to commit conventions
 * [Usage](#usage)
   * [Installation](#installation)
   * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -45,7 +48,7 @@ import {scaffold} from '@form8ion/commit-convention';
 
 ```javascript
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  await scaffold({projectRoot: process.cwd(), configs: {}});
 })();
 ```
 
@@ -109,3 +112,7 @@ $ npm test
 [runkit-link]: https://npm.runkit.com/@form8ion/commit-convention
 
 [runkit-badge]: https://badge.runkitcdn.com/@form8ion/commit-convention.svg
+
+[coverage-link]: https://codecov.io/github/form8ion/commit-convention
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/commit-convention.svg

example.js

@@ -9,5 +9,5 @@ stubbedFs();
 // #### Execute
 
 (async () => {
-  await scaffold({projectRoot: process.cwd()});
+  await scaffold({projectRoot: process.cwd(), configs: {}});
 })();