Update README and configuration files for initial setup and CI/CD

Author: renatodellosso

.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    assignees: ["renatodellosso"]
+    schedule:
+      day: "monday"
+      interval: "weekly"
+    commit-message:
+      prefix: "[npm]"

.github/workflows/cd.yml

@@ -0,0 +1,41 @@
+name: CD
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  packages: write
+
+jobs:
+  build_and_push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and export
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_SUMMARY: false
+        with:
+          tags: ghcr.io/decatur-robotics/gearbox:latest
+          outputs: type=docker,dest=/tmp/gearbox.tar
+          context: . # Needed for Docker to find files made during the workflow
+
+      - name: Load image
+        run: |
+          docker load --input /tmp/gearbox.tar
+          docker image ls -a
+
+      - name: Sign in to GHCR
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u decatur-robotics --password-stdin
+
+      - name: Push to GHCR
+        run: docker push ghcr.io/decatur-robotics/gearbox:latest

README.md

@@ -1,3 +1,8 @@
 # NPM Package Template
 
+To get started, use this repo as a template and do the following:
+
+- Update the details in package.json
+- Update the assignees in .github/dependabot.yml
+
 NPM Package Template © 2024 by Decatur Robotics is licensed under CC BY 4.0

package.json

@@ -6,6 +6,9 @@
   "license": "CC0 1.0",
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/Decatur-Robotics/npm-package-template"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
   }
 }