From f14c35446891ba9cba9448964e0e27bff7d44783 Mon Sep 17 00:00:00 2001 From: Kurdistan Tech Ministry Date: Wed, 7 Jan 2026 03:14:40 +0300 Subject: [PATCH] chore: update README and workflows for PezkuwiChain rebrand - Update README with Dijital Kurdistan Tech Institute author - Fix lock.yml to use github.token instead of GH_PAT_BOT - Rename push-master.yml to push-main.yml for main branch - Add workflow_dispatch triggers for manual runs --- .github/workflows/lock.yml | 7 ++- .github/workflows/push-main.yml | 23 +++++++++ .github/workflows/push-master.yml | 31 ------------ README.md | 84 +++++++++++++++++++++++++++---- 4 files changed, 99 insertions(+), 46 deletions(-) create mode 100644 .github/workflows/push-main.yml delete mode 100644 .github/workflows/push-master.yml diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml index d608e67f..da2ca9f0 100644 --- a/.github/workflows/lock.yml +++ b/.github/workflows/lock.yml @@ -1,18 +1,17 @@ name: 'Lock Threads' on: + workflow_dispatch: schedule: - cron: '25 2/3 * * *' jobs: lock: runs-on: ubuntu-latest - env: - YARN_ENABLE_SCRIPTS: false steps: - - uses: dessant/lock-threads@c1b35aecc5cdb1a34539d14196df55838bb2f836 + - uses: dessant/lock-threads@v5 with: - github-token: ${{ secrets.GH_PAT_BOT }} + github-token: ${{ github.token }} issue-inactive-days: '7' issue-comment: > This thread has been automatically locked since there has not been diff --git a/.github/workflows/push-main.yml b/.github/workflows/push-main.yml new file mode 100644 index 00000000..f484f0bc --- /dev/null +++ b/.github/workflows/push-main.yml @@ -0,0 +1,23 @@ +name: Main +on: + workflow_dispatch: + push: + branches: + - main + +jobs: + build: + if: "! startsWith(github.event.head_commit.message, '[CI Skip]')" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 'lts/*' + - name: Build + run: | + corepack enable + yarn install --immutable + yarn build diff --git a/.github/workflows/push-master.yml b/.github/workflows/push-master.yml deleted file mode 100644 index 4082c93a..00000000 --- a/.github/workflows/push-master.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Master -on: - push: - branches: - - master - -jobs: - master: - if: "! startsWith(github.event.head_commit.message, '[CI Skip]')" - strategy: - matrix: - step: ['build:release'] - runs-on: ubuntu-latest - env: - YARN_ENABLE_SCRIPTS: false - CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }} - GH_PAT: ${{ secrets.GH_PAT_BOT }} - GH_RELEASE_GITHUB_API_TOKEN: ${{ secrets.GH_PAT_BOT }} - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - token: ${{ secrets.GH_PAT_BOT }} - - uses: actions/setup-node@v4 - with: - node-version: 'lts/*' - - name: ${{ matrix.step }} - run: | - yarn install --immutable - yarn ${{ matrix.step }} diff --git a/README.md b/README.md index 859ddb02..0c1cf21b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,80 @@ # @pezkuwi/ui -Basic browser and framework agnostic UI components for creating apps using the polkadot{.js} libraries +Basic browser and framework agnostic UI components for creating apps using the PezkuwiChain libraries. -## overview +**Developed by Dijital Kurdistan Tech Institute** -The following UI components are currently available - +## Overview -- [react-identicon](packages/react-identicon/) React identity icon generator with address as input -- [reactnative-identicon](packages/reactnative-identicon/) React Native identity icon generator with address as input -- [vue-identicon](packages/vue-identicon/) Vue identity icon generator with address as input -- [react-qr](packages/react-qr/) QR code generator/reader for [uos](https://github.com/maciejhirsz/uos) (Substrate/Polkadot only) +This package provides UI components for building applications on PezkuwiChain. -Additionally some shared libraries, that are not dependent on any framework - +## Packages -- [ui-keyring](packages/ui-keyring/) A browser-specific wrapper around the base [@pezkuwi/keyring](https://github.com/pezkuwichain/common/) library -- [ui-settings](packages/ui-settings/) A browser local storage wrapper for app settings & configuration -- [ui-shared](packages/ui-shared) Shared logic that is used across UI components, e.g. for icon generation +### UI Components + +- [react-identicon](packages/react-identicon/) - React identity icon generator with address as input +- [reactnative-identicon](packages/reactnative-identicon/) - React Native identity icon generator with address as input +- [vue-identicon](packages/vue-identicon/) - Vue identity icon generator with address as input +- [react-qr](packages/react-qr/) - QR code generator/reader for PezkuwiChain + +### Shared Libraries + +- [ui-keyring](packages/ui-keyring/) - A browser-specific wrapper around [@pezkuwi/keyring](https://github.com/pezkuwichain/pezkuwi-common/) +- [ui-settings](packages/ui-settings/) - A browser local storage wrapper for app settings +- [ui-shared](packages/ui-shared/) - Shared logic used across UI components (e.g., icon generation) + +## Installation + +```bash +# Using npm +npm install @pezkuwi/react-identicon + +# Using yarn +yarn add @pezkuwi/react-identicon +``` + +## Usage + +```javascript +import Identicon from '@pezkuwi/react-identicon'; + +function App() { + return ( + + ); +} +``` + +## Development + +### Prerequisites + +- Node.js >= 18.14 +- Yarn 4.x (via corepack) + +### Building + +```bash +corepack enable +yarn install +yarn build +``` + +## Links + +- Website: https://pezkuwichain.io +- Documentation: https://docs.pezkuwichain.io +- GitHub: https://github.com/pezkuwichain +- API Docs: https://js.pezkuwichain.app + +## License + +Apache-2.0 + +## Author + +Dijital Kurdistan Tech Institute