diff --git a/README.md b/README.md index cc581198..4c50e8ed 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ PezkuwiChain is designed to host **multiple digital nations** simultaneously: ```bash # Clone repository -git clone https://github.com/pezkuwichain/pezkuwi-sdk.git +git clone https://git.pezkuwichain.io/pezkuwichain/pezkuwi-sdk.git cd pezkuwi-sdk # Build release @@ -217,7 +217,7 @@ cargo build --release --features runtime-benchmarks | Telegram | [@pezkuwichain](https://t.me/pezkuwichain) | | Discord | [discord.gg/pezkuwichain](https://discord.gg/pezkuwichain) | | Twitter | [@pezkuwichain](https://twitter.com/pezkuwichain) | -| GitHub | [github.com/pezkuwichain](https://github.com/pezkuwichain) | +| Gitea | [git.pezkuwichain.io/pezkuwichain](https://git.pezkuwichain.io/pezkuwichain) | | Medium | [@pezkuwichain](https://medium.com/@pezkuwichain) | | Facebook | [PezkuwiChain](https://www.facebook.com/profile.php?id=61582484611719) | @@ -230,10 +230,10 @@ cargo build --release --features runtime-benchmarks # Pezkuwi SDK -![GitHub stars](https://img.shields.io/github/stars/pezkuwichain/pezkuwi-sdk)  ![GitHub forks](https://img.shields.io/github/forks/pezkuwichain/pezkuwi-sdk) +[![GitLab stars](https://img.shields.io/gitlab/stars/pezkuwichain%2Fpezkuwi-sdk?gitlab_url=https%3A%2F%2Fgitlab.com&logo=gitlab)](https://gitlab.com/pezkuwichain/pezkuwi-sdk)  [![GitLab forks](https://img.shields.io/gitlab/forks/pezkuwichain%2Fpezkuwi-sdk?gitlab_url=https%3A%2F%2Fgitlab.com&logo=gitlab)](https://gitlab.com/pezkuwichain/pezkuwi-sdk) -[![StackExchange](https://img.shields.io/badge/StackExchange-Community%20&%20Support-222222?logo=stackexchange)](https://pezkuwichain.io/community)  ![GitHub contributors](https://img.shields.io/github/contributors/pezkuwichain/pezkuwi-sdk)  ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/pezkuwichain/pezkuwi-sdk)  ![GitHub last commit](https://img.shields.io/github/last-commit/pezkuwichain/pezkuwi-sdk) +[![StackExchange](https://img.shields.io/badge/StackExchange-Community%20&%20Support-222222?logo=stackexchange)](https://pezkuwichain.io/community)  [![GitLab contributors](https://img.shields.io/gitlab/contributors/pezkuwichain%2Fpezkuwi-sdk?gitlab_url=https%3A%2F%2Fgitlab.com)](https://gitlab.com/pezkuwichain/pezkuwi-sdk/-/graphs/main)  [![GitLab last commit](https://img.shields.io/gitlab/last-commit/pezkuwichain%2Fpezkuwi-sdk?gitlab_url=https%3A%2F%2Fgitlab.com)](https://gitlab.com/pezkuwichain/pezkuwi-sdk/-/commits/main) > The Pezkuwi SDK repository provides all the components needed to start building on the > [PezkuwiChain](https://pezkuwichain.io/) network, a multi-chain blockchain platform that enables @@ -246,7 +246,7 @@ cargo build --release --features runtime-benchmarks If you want to get an example node running quickly you can execute the following getting started script: ```bash -curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/pezkuwichain/pezkuwi-sdk/master/scripts/getting-started.sh | bash +curl --proto '=https' --tlsv1.2 -sSf https://gitlab.com/pezkuwichain/pezkuwi-sdk/-/raw/main/scripts/getting-started.sh | bash ``` ## Building @@ -256,11 +256,11 @@ In order to build this project you need to install some dependencies, follow the ## Documentation - [Pezkuwi Documentation Portal](https://docs.pezkuwichain.io) -- [rust-docs](https://pezkuwichain.github.io/pezkuwi-sdk/master/pezkuwi_sdk_docs/index.html): Where we keep track of the API docs of our Rust crates. Includes: - - [Introduction](https://pezkuwichain.github.io/pezkuwi-sdk/master/pezkuwi_sdk_docs/pezkuwi_sdk/index.html) to each component of the Pezkuwi SDK: Bizinikiwi, FRAME, PezCumulus, and XCM - - [Guides](https://pezkuwichain.github.io/pezkuwi-sdk/master/pezkuwi_sdk_docs/guides/index.html), namely how to build your first FRAME pallet - - [Templates](https://pezkuwichain.github.io/pezkuwi-sdk/master/pezkuwi_sdk_docs/pezkuwi_sdk/templates/index.html) for starting a new project. - - [External Resources](https://pezkuwichain.github.io/pezkuwi-sdk/master/pezkuwi_sdk_docs/external_resources/index.html) +- [rust-docs](https://pezkuwichain.gitlab.io/pezkuwi-sdk/pezkuwi_sdk_docs/index.html): Where we keep track of the API docs of our Rust crates. Includes: + - [Introduction](https://pezkuwichain.gitlab.io/pezkuwi-sdk/pezkuwi_sdk_docs/pezkuwi_sdk/index.html) to each component of the Pezkuwi SDK: Bizinikiwi, FRAME, PezCumulus, and XCM + - [Guides](https://pezkuwichain.gitlab.io/pezkuwi-sdk/pezkuwi_sdk_docs/guides/index.html), namely how to build your first FRAME pallet + - [Templates](https://pezkuwichain.gitlab.io/pezkuwi-sdk/pezkuwi_sdk_docs/pezkuwi_sdk/templates/index.html) for starting a new project. + - [External Resources](https://pezkuwichain.gitlab.io/pezkuwi-sdk/pezkuwi_sdk_docs/external_resources/index.html) - Have a question? You can ask in the Pezkuwi SDK Developers Chat. - [Telegram](https://t.me/DKSPezkuwiChain) - [Matrix](https://matrix.to/#/#pezkuwidevs:matrix.org) @@ -270,15 +270,13 @@ In order to build this project you need to install some dependencies, follow the ## Releases -![Current Stable Release](https://raw.githubusercontent.com/pezkuwichain/release-registry/main/badges/pezkuwi-sdk-latest.svg)  ![Next Stable Release](https://raw.githubusercontent.com/pezkuwichain/release-registry/main/badges/pezkuwi-sdk-next.svg) +The Pezkuwi SDK is released every three months as a `Pezkuwi stableYYMM` release. Each stable release is supported for one year with patches. See the release history in [CHANGELOG.md](./CHANGELOG.md) and release documentation in [RELEASE.md](./docs/RELEASE.md). -The Pezkuwi SDK is released every three months as a `Pezkuwi stableYYMM` release. Each stable release is supported for one year with patches. See the next upcoming versions in the [Release Registry](https://github.com/pezkuwichain/release-registry/) and more docs in [RELEASE.md](./docs/RELEASE.md). - -You can use [`psvm`](https://github.com/pezkuwichain/psvm) to update all dependencies to a specific version without needing to manually select the correct version for each crate. +You can use [`psvm`](https://git.pezkuwichain.io/pezkuwichain/psvm) to update all dependencies to a specific version without needing to manually select the correct version for each crate. ## Tooling -[Pezkuwi SDK Version Manager](https://github.com/pezkuwichain/psvm): A simple tool to manage and update the Pezkuwi SDK dependencies in any Cargo.toml file. It will automatically update the Pezkuwi SDK dependencies to their correct crates.io version. +[Pezkuwi SDK Version Manager](https://git.pezkuwichain.io/pezkuwichain/psvm): A simple tool to manage and update the Pezkuwi SDK dependencies in any Cargo.toml file. It will automatically update the Pezkuwi SDK dependencies to their correct crates.io version. ## Security @@ -290,11 +288,11 @@ Ensure you follow our [contribution guidelines](./docs/contributor/CONTRIBUTING. ### Ready to Contribute? -Take a look at the issues labeled with [`mentor`](https://github.com/pezkuwichain/pezkuwi-sdk/labels/C1-mentor) (or alternatively [this](https://mentor.tasty.limo/) page, created by one of the maintainers) label to get started! We always recognize valuable contributions by proposing an on-chain tip to the PezkuwiChain network as a token of our appreciation. +Take a look at the issues labeled with [`mentor`](https://gitlab.com/pezkuwichain/pezkuwi-sdk/-/issues?label_name=C1-mentor) to get started! We always recognize valuable contributions by proposing an on-chain tip to the PezkuwiChain network as a token of our appreciation. ## Pezkuwi Fellowship -Development in this repo usually goes hand in hand with the `fellowship` organization. In short, this repository provides all the SDK pieces needed to build both PezkuwiChain and its teyrchains. But, the actual PezkuwiChain runtime lives in the `fellowship/runtimes` repository. Read more about the fellowship, this separation, and the RFC process in the [Pezkuwi Fellows repository](https://github.com/pezkuwichain/pezkuwi-fellows). +Development in this repo usually goes hand in hand with the `fellowship` organization. In short, this repository provides all the SDK pieces needed to build both PezkuwiChain and its teyrchains. But, the actual PezkuwiChain runtime lives in the `fellowship/runtimes` repository. Read more about the fellowship, this separation, and the RFC process in the [Pezkuwi Fellows repository](https://git.pezkuwichain.io/pezkuwichain/pezkuwi-fellows). ## History @@ -307,12 +305,14 @@ This repository is the amalgamation of 3 separate repositories that used to make Pezkuwi SDK is a derivative work based on [Polkadot SDK](https://github.com/paritytech/polkadot-sdk) by [Parity Technologies (UK) Ltd.](https://www.parity.io), used under Apache-2.0 and GPL-3.0-only. -Individual crates in this repository are licensed under either: +Individual crates in this repository are licensed under one of: - **Apache License, Version 2.0** — see [LICENSE-APACHE](./LICENSE-APACHE) -- **GNU General Public License, Version 3.0** — see [LICENSE-GPL3](./LICENSE-GPL3) +- **GNU General Public License v3 or later WITH Classpath-exception-2.0** — see [LICENSE-GPL3](./LICENSE-GPL3) +- **MIT No Attribution (MIT-0)** — see [LICENSE-MIT0](./LICENSE-MIT0) +- **The Unlicense** — see [LICENSE-UNLICENSE](./LICENSE-UNLICENSE) -See each crate's `Cargo.toml` for the applicable license. +See each crate's `Cargo.toml` `license` field and each source file's `SPDX-License-Identifier` header for the applicable license. For full attribution, significant changes, and third-party component notices, see [NOTICE](./NOTICE).