✨ Set up npm package

marcreichel · May 17, 2021 · 6e42c9e · 6e42c9e
1 parent 1f7c183
commit 6e42c9e
Show file tree

Hide file tree

Showing 15 changed files with 3,865 additions and 61 deletions.
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -0,0 +1,31 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
 .idea/
+node_modules/
+.DS_Store
+apple-tv-card-*.tgz
diff --git a/README.md b/README.md
@@ -1,28 +1,40 @@
 # Apple TV Card (with JavaScript and CSS)
 
+[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev)
+
 An Apple TV Card/Widget with hover animation written in JavaScript and CSS.
 
 
 ## Demo
 
-[Live-Demo](https://marcreichel.github.io/apple-tv-card/)
+![Animation](docs/demo.gif)
 
+[Live-Demo](https://marcreichel.github.io/apple-tv-card/)
 
-## Run Locally
 
-Clone the project
+## Installation
 
+Install via npm:
 ```bash
-  git clone https://github.com/marcreichel/apple-tv-card.git
+  npm install apple-tv-card
 ```
 
-Go to the project directory
+or yarn:
 
 ```bash
-  cd apple-tv-card
+  yarn add apple-tv-card
 ```
 
-Open `index.html` in your browser.
+
+## Setup
+
+
+_More info coming soon_
+
+
+## Authors
+
+- [@marcreichel](https://www.github.com/marcreichel)
 
 
 ## Contributing

diff --git a/apple-tv-cards.css b/apple-tv-cards.css
diff --git a/app.css → demo.css b/app.css → demo.css
diff --git a/dist/main.css b/dist/main.css
diff --git a/dist/main.js b/dist/main.js
diff --git a/Apple_logo_white.svg → docs/Apple_logo_white.svg b/Apple_logo_white.svg → docs/Apple_logo_white.svg
diff --git a/docs/demo.gif b/docs/demo.gif
diff --git a/index.html b/index.html
@@ -9,9 +9,9 @@
 
     <link rel="preconnect" href="https://fonts.gstatic.com">
     <link href="https://fonts.googleapis.com/css2?family=Roboto&display=swap" rel="stylesheet">
-    <link href="apple-tv-cards.css" rel="stylesheet">
-    <link href="app.css" rel="stylesheet">
-    <script src="apple-tv-cards.js" defer></script>
+    <link href="dist/main.css" rel="stylesheet">
+    <link href="demo.css" rel="stylesheet">
+    <script src="dist/main.js" defer></script>
 </head>
 <body>
 <div class="container">
@@ -20,7 +20,7 @@
             <div class="content" style="background-image:linear-gradient(to bottom, #555, #000);padding-bottom: 58.33333333%;"></div>
             <div class="paralax-content">
                 <div style="font-size:6rem;">
-                    <img src="Apple_logo_white.svg" style="height:.75em;margin-right:-.15em;" alt="Apple Logo">
+                    <img src="docs/Apple_logo_white.svg" style="height:.75em;margin-right:-.15em;" alt="Apple Logo">
                     tv
                 </div>
             </div>