From bcd6ff408f44a30043fa5e068cd830b59ae552f8 Mon Sep 17 00:00:00 2001 From: Bulat Saifullin Date: Thu, 25 Jul 2024 09:55:43 +0300 Subject: [PATCH] Update README.md (#348) --- charts/node/README.md | 12 ++++++++++++ charts/node/README.md.gotmpl | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/charts/node/README.md b/charts/node/README.md index f895a48e..54080207 100644 --- a/charts/node/README.md +++ b/charts/node/README.md @@ -20,6 +20,18 @@ This is intended behaviour. Make sure to run `git add -A` once again to stage ch ![Version: 5.10.0](https://img.shields.io/badge/Version-5.10.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) +## Overview +The Polkadot Helm Chart provides a convenient way to deploy and manage a Polkadot blockchain node in a Kubernetes cluster. +This chart is designed to be highly configurable, supporting various configurations and features of the Polkadot node, +including persistent storage, resource management, and custom networking. + +**Features:** +- Compatible with all Substrate-based relaychains, including Polkadot, Kusama, Paseo, Westend, Rococo, and more. +- Compatible with all Substrate-based parachains, including Asset-hub, Bridge-hub, Coretime, People, Acala, Astar, Moonbase, and others. +- Deploy RPC, collators, validators, or full nodes in a Kubernetes cluster. +- Use snapshots to speed up the deployment process. +- Supports session key and node-key (ID) injection. + ## Maintainers | Name | Email | Url | diff --git a/charts/node/README.md.gotmpl b/charts/node/README.md.gotmpl index 59fc00c6..0002ebbb 100644 --- a/charts/node/README.md.gotmpl +++ b/charts/node/README.md.gotmpl @@ -20,6 +20,18 @@ This is intended behaviour. Make sure to run `git add -A` once again to stage ch {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} +## Overview +The Polkadot Helm Chart provides a convenient way to deploy and manage a Polkadot blockchain node in a Kubernetes cluster. +This chart is designed to be highly configurable, supporting various configurations and features of the Polkadot node, +including persistent storage, resource management, and custom networking. + +**Features:** +- Compatible with all Substrate-based relaychains, including Polkadot, Kusama, Paseo, Westend, Rococo, and more. +- Compatible with all Substrate-based parachains, including Asset-hub, Bridge-hub, Coretime, People, Acala, Astar, Moonbase, and others. +- Deploy RPC, collators, validators, or full nodes in a Kubernetes cluster. +- Use snapshots to speed up the deployment process. +- Supports session key and node-key (ID) injection. + {{ template "chart.maintainersSection" . }} ## Installing the chart