Proper README (#1)

This commit is contained in:
Skyler Mäntysaari 2023-03-05 09:10:21 +02:00 committed by GitHub
parent b34176b7ec
commit c1c35ef639
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 3 deletions

View File

@ -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)