chore: change license to mit (#41)

* docs: change license to mit * ci: update actions to use v4 of checkout, setup-node and cache * docs: add new badges and update deploy badge
kibis-is · Feb 8, 2024 · 556e905 · 556e905
1 parent 01ef23e
commit 556e905
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 353 deletions.
diff --git a/.github/actions/use-dependencies/action.yml b/.github/actions/use-dependencies/action.yml
@@ -6,12 +6,12 @@ runs:
   using: "composite"
   steps:
     - name: "🔧 Setup"
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: 'lts/*'
         cache: 'yarn'
     - name: "💾 Cache dependencies"
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       id: cache-dependencies
       with:
         path: node_modules

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
 
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
       - name: "🏗️ Build"

diff --git a/.github/workflows/pull_request_checks.yml b/.github/workflows/pull_request_checks.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
 
@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
       - name: "👕 Lint"
@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
       - name: "🏗️ Build"
@@ -51,7 +51,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
         uses: ./.github/actions/use-dependencies
       - name: "🧪 Test"

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: "🔧 Setup"
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 'lts/*'
+          node-version: 20.9.0
           cache: 'yarn'
       - name: "📦 Install"
         run: yarn global add semantic-release @semantic-release/commit-analyzer @semantic-release/release-notes-generator @semantic-release/npm @semantic-release/github @semantic-release/git @semantic-release/changelog

diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -12,16 +12,28 @@
   The front facing website for the Kibisis wallet.
 </p>
 
-<p p align="center">
-  The website is built using <a href="https://docusaurus.io/" target="_blank">Docusaurus</a> and fills the role of landing page, tutorial and blog.
+<p align="center">
+  <a href="https://github.com/agoralabs-sh/kibisis-website/releases/latest">
+    <img alt="GitHub Release" src="https://img.shields.io/github/v/release/agoralabs-sh/kibisis-website?&logo=github">
+  </a>
+  <a href="https://github.com/agoralabs-sh/kibisis-website/releases/latest">
+    <img alt="GitHub Release Date - Published At" src="https://img.shields.io/github/release-date/agoralabs-sh/kibisis-website?logo=github">
+  </a>
+  <a href="https://github.com/agoralabs-sh/kibisis-website/actions/workflows/deploy.yml">
+    <img alt="GitHub Actions Deploy Workflow Status" src="https://img.shields.io/github/actions/workflow/status/agoralabs-sh/kibisis-website/deploy.yml?label=deploy" />
+  </a>
 </p>
 
 <p align="center">
-  <a href="https://github.com/agoralabs-sh/kibisis-website/actions/workflows/deploy.yml">
-    <img src="https://github.com/agoralabs-sh/kibisis-website/actions/workflows/deploy.yml/badge.svg?branch=main" alt="Deploy" />
+  <a href="https://github.com/agoralabs-sh/kibisis-website/blob/main/LICENSE">
+    <img alt="GitHub License" src="https://img.shields.io/github/license/agoralabs-sh/kibisis-website">
   </a>
 </p>
 
+<p p align="center">
+  The website is built using <a href="https://docusaurus.io/" target="_blank">Docusaurus</a> and fills the role of landing page, tutorial and blog for Kibisis.
+</p>
+
 ### Table of contents
 
 * [1. Overview](#-1-overview)
@@ -47,7 +59,7 @@ TBA...
 
 ## 📋 2. Requirements
 
-* Install [Node v16.14.0][node]
+* Install [Node v20.9.0][node]
 * Install [Yarn v1.22.5+][yarn]
 
 <sup>[Back to top ^][table-of-contents]</sup>
@@ -93,6 +105,18 @@ Although the deployment is handled through the CI (GitHub Actions), it is necess
 
 ###  5.3. Deploy to `gh-pages` branch
 
+1. If this is a new repo, first create a new orphaned branch with no history and no files:
+```shell
+git checkout --orphan gh-pages
+```
+
+2. Add an initial empty commit:
+```shell
+git commit --allow-empty -m "chore: initial commit" && git push -u origin/gh-pages
+```
+
+3. TBC...
+
 <sup>[Back to top ^][table-of-contents]</sup>
 
 ## 📑 6. Miscellaneous

diff --git a/package.json b/package.json
@@ -11,14 +11,14 @@
     "email": "[email protected]",
     "url": "https://github.com/kieranroneill"
   },
-  "license": "GPL-2.0-or-later",
+  "license": "MIT",
   "keywords": [
     "algorand",
     "blockchain"
   ],
   "private": true,
   "engines": {
-    "node": ">=16.14"
+    "node": ">=20.9.0"
   },
   "browserslist": {
     "production": [