From c1c35ef63912fc94b111a2901b280816d2d782d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Skyler=20M=C3=A4ntysaari?= Date: Sun, 5 Mar 2023 09:10:21 +0200 Subject: [PATCH] Proper README (#1) --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9fb6e64..659de4f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ -# Piped deployment on Kubernetes +# Piped-Kubernetes -WORK IN PROGRESS +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/piped-kubernetes)](https://artifacthub.io/packages/search?repo=piped-kubernetes) -This repo will house a Helm chart for Kubernetes deployments. +## Usage +[Helm](https://helm.sh) must be installed to use the charts. +Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. + +Once Helm is set up properly, add the repo as follows: + +```console +helm repo add TeamPiped https://helm.piped.video/ +``` + +You can then run `helm search repo TeamPiped` to see the charts. + + +## Support + +- Bugs or feature requests should be opened in an [issue](https://github.com/TeamPiped/Piped-Kubernetes/issues/new/choose). + + +## License + +[AGPL License](./LICENSE)