Merge pull request #1 from ProAngular/ct/documentation

Update readme and deploy hooks

Author: CodyTolene

.github/workflows/on-merge-main.yml

@@ -0,0 +1,41 @@
+name: "Verify and Deploy"
+on:
+  push:
+    branches:
+      - main
+jobs:
+  verify_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Checkout 🛎️
+        run: npm ci
+
+      - name: Verify Code 👌
+        run: |
+          npm run lint
+          npm run prettier:check
+
+      - name: Build 🔧
+        run: |
+          npm run build:prod
+          npm run npm-build-package
+
+      # https://docs.npmjs.com/about-packages-and-modules
+      - uses: actions/setup-node@v3
+      - name: Deploy Package to `npmjs` 🚀
+        with:
+          registry-url: "https://registry.npmjs.org"
+        run: npm publish --access public --folder dist/npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      # https://docs.github.com/en/packages
+      # https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+      - uses: actions/setup-node@v3
+      - name: Deploy Package to `gpr` 🚀
+        with:
+          registry-url: "https://npm.pkg.github.com"
+        run: npm publish --access public --folder dist/npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/verify-pull-request.yml

@@ -1,14 +1,19 @@
-name: Verify Pull Request
-"on": pull_request
+name: "Verify Pull Request"
+on: pull_request
 jobs:
-  build:
+  verify_pull_request:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v3
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
-      - name: Build Check 🔧
+        run: npm ci
+
+      - name: Verify Code 👌
         run: |
-          npm ci
           npm run lint
           npm run prettier:check
+
+      - name: Build 🔧
+        run: |
           npm run build:prod
+          npm run npm-build-package

.prettierignore

@@ -4,5 +4,6 @@
 # Except these files and directories:
 !.github/
 !.husky/
+!.scripts/
 !e2e/src
 !src/

README.md

@@ -1,3 +1,12 @@
+<p align="center">
+  <img src="src/assets/pro-angular-logo.svg?sanitize=true">
+  <h1 align="center">Angular Scroll Top Button</h1>
+</p>
+
+[![npm version](https://badge.fury.io/js/@proangular%2Fngx-scroll-top.svg)](https://badge.fury.io/js/@proangular%2Fngx-scroll-top)
+[![NPM Downloads](https://img.shields.io/amo/dw/@proangular%252Fngx-scroll-top.svg)](https://www.npmjs.com/@proangular/ngx-scroll-top)
+[![Join the chat at https://gitter.im/ProAngular/community](https://badges.gitter.im/ProAngular/lobby.svg)](https://gitter.im/ProAngular/community)
+
 # ngx-scroll-top
 Configurable, lightweight back to top button for Angular projects