Merge pull request #3 from vidhill/feature/add-circle-ci

.circleci/config.yml

@@ -0,0 +1,36 @@
+
+version: 2.1
+
+orbs:
+  node: circleci/node@4.1
+
+
+jobs:
+  build-and-test:  
+    # A list of available CircleCI Docker Convenience Images are available here: https://circleci.com/developer/images/image/cimg/node
+    docker:
+      - image: cimg/node:15.1
+
+    steps:
+      # Checkout the code as the first step.
+      - checkout
+      - node/install-packages
+      - run:
+          name: Run lint
+          command: npm run lint
+      - run:
+          name: Run tests
+          command: npm test
+      # persist code coverage report
+      - store_artifacts:
+          path: coverage
+
+
+workflows:
+  # Below is the definition of your workflow.
+  # Inside the workflow, you provide the jobs you want to run, e.g this workflow runs the build-and-test job above.
+  # CircleCI will run this workflow on every commit.
+  # For more details on extending your workflow, see the configuration docs: https://circleci.com/docs/2.0/configuration-reference/#workflows
+  main: 
+    jobs:
+      - build-and-test

.gitignore

@@ -6,9 +6,6 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
-# Ignore package-lock for the template repo
-package-lock.json
-
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

README.md

@@ -1,6 +1,8 @@
 # @vidhill/fortawesome-brands-11ty-shortcode
 
-Allows fortawesome brand icons to be embedded as inline svg into [11ty](https://www.11ty.dev/) templates.
+[Eleventy/11ty](https://www.11ty.dev/) shortcode.
+
+Allows [@fortawesome/free-brands-svg-icons](https://www.npmjs.com/package/@fortawesome/free-brands-svg-icons) to be embedded as inline svg into 11ty templates.
 
 See brand icon names here: [font-awesome-5-brands](https://fortawesome.com/sets/font-awesome-5-brands)