diff --git a/README.md b/README.md new file mode 100644 index 0000000..06baf94 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Polkadot Releases +> ⚠️ NOTE: These builds are provided for development purposes only! + +This repo provides cross-platform builds of Polkadot and related binaries for usage with [`pop-cli`](https://github.com/r0gue-io/pop-cli) only. + +Builds are generated using the release tags at https://github.com/paritytech/polkadot-sdk/releases, along with the Rust compiler version noted within the release notes of each release. + +The [workflow](./.github/workflows/release.yml) generates the cross-platform binaries and creates a corresponding release with the same release tag. The corresponding commit hash is added to the release notes for additional verification. + +## Support Platforms +The currently supported platforms/targets are as follows: +- Linux + - `aarch64-unknown-linux-gnu` + - `x86_64-unknown-linux-gnu` +- macOS + - `aarch64-apple-darwin` + - `x86_64-apple-darwin`