Merge branch 'release/3.3.2'

.circleci/config.yml

@@ -1,43 +1,27 @@
-version: 2
+version: 2.1
 
-jobs:
-  build:
-    docker:
-      - image: circleci/node:latest
+orbs:
+  node: circleci/node@4.7.0
+  codecov: codecov/codecov@3.2.0
 
+jobs:
+  test:
+    executor:
+      name: node/default
+      tag: 'current'
     steps:
       - checkout
-
-      - restore_cache:
-          keys:
-          - dependencies-v2-{{ checksum "package.json" }}
-
-      - run:
-          name: Install global packages
-          command: sudo npm install -g codecov
-
-      - run:
-          name: Install dependencies
-          command: npm install
-
-      - save_cache:
-          key: dependencies-v2-{{ checksum "package.json" }}
-          paths:
-            - node_modules
-
+      - node/install-packages
       - run:
           name: Javascript Linter
           command: npm run lint
-
       - run:
-          name: All Unit Tests with Code Coverage
+          name: Unit tests with code coverage
           command: npm run test:unit:cov
 
-      # Mutation Tests do not run reliably on CI
-      # - run:
-      #     name: Mutation Tests
-      #     command: npm run test:mutants
-
-      - run:
-          name: Send reports to codecov.io
-          command: codecov
+workflows:
+  node-tests:
+    jobs:
+      - test:
+          post-steps:
+            - codecov/upload

README.md

@@ -4,7 +4,7 @@ Connect [`Express`](http://www.expressjs.com) route controllers to restful paths
 
 [![NPM](https://nodei.co/npm/swagger-routes-express.png)](https://nodei.co/npm/swagger-routes-express/)
 
-## Prerequisites
+## Assumptions
 
 This library assumes you are using:
 
@@ -490,7 +490,7 @@ const { connector } = require('swagger-routes-express')
 
 ## Development
 
-## Branches
+### Branches
 
 <!-- prettier-ignore -->
 | Branch | Status | Coverage | Audit | Notes |
@@ -513,6 +513,15 @@ const { connector } = require('swagger-routes-express')
 npm run lint
 ```
 
+## Starter templates and examples of use
+
+The following projects use `swagger-routes-express` as a starter template.
+
+- My own [`api-server-boilerplate`](https://github.com/davesag/api-server-boilerplate), and
+- [`node-express-open-api-skeleton`](https://github.com/ReubenFrimpong/node-express-open-api-skeleton) by [Reuben Frimpong](https://github.com/ReubenFrimpong).
+
+_Note_: If you have a template or example of use to add to this list please just raise a PR and I'll take a look.
+
 ## Contributing
 
 Please see the [contributing notes](CONTRIBUTING.md).