Merge branch 'nagy-nabil-gh-release'

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: 'Build And Create New Release'
+
+on:
+ push:
+ branches:
+ - main
+permissions:
+ contents: write
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Install NodeJs v14
+ uses: actions/setup-node@v3
+ with:
+ # Version Spec of the version to use in SemVer notation.
+ # It also emits such aliases as lts, latest, nightly and canary builds
+ # Examples: 12.x, 10.15.1, >=10.15.0, lts/Hydrogen, 16-nightly, latest, node
+ node-version: '14.x'
+
+ - name: Run Install
+ uses: borales/actions-yarn@v4
+ with:
+ cmd: install
+ - name: Build production bundle
+ uses: borales/actions-yarn@v4
+ with:
+ cmd: build # will run `yarn build` command
+
+ - name: Release
+ uses: softprops/action-gh-release@v1
+ if: startsWith(github.ref, 'refs/tags/')
+ with:
+ files: |
+ extension/chrome.zip
+ extension/firefox.xpi
+ extension/opera.crx

README.md

@@ -1,2 +1,27 @@
 # alt-cdn
+
 Experiencing a situation where your country inexplicably blocks certain content delivery networks, like jsDelivr, can be quite frustrating. This leads to numerous broken websites due to missing essential JavaScript files. This extension provides an alternative to using a VPN. It simply asks for a list of preferred providers (usually just one for most people) and automatically replaces the blocked content with suitable alternatives.
+
+## Installation
+
+- from releases download the package to your browser `chrome.zip`, `firefox.xpi` or `opera.crx`
+
+- in chrome goto `chrome:https://extensions/` and enable developer mode, then drag drop the `chrome.zip` file
+
+- if you want to load from source check [Contributing](#contributing)
+
+## Contributing
+
+- make sure you have node.js v14 `nvm use 14`
+
+- install yarn `npm i -g yarn`
+
+- install `yarn install`
+
+- run dev command for your browser `yarn dev:chome` or `yarn dev:firefox` or `yarn dev:opera`
+
+- add the extension to your browser
+ - In Chrome/Edge 
+ 1. go to the extensions page (`chrome:https://extensions` or `edge:https://extensions`).
+ 2. Enable Developer Mode.
+ 3. click `load unpacked` then select `$your-project-path/extension/chrome`