Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: change license to mit #41

Merged
merged 3 commits into from
Feb 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/actions/use-dependencies/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pull_request_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
340 changes: 5 additions & 335 deletions LICENSE

Large diffs are not rendered by default.

34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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>
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down