chore: add README and LICENSE (#16)

This commit is contained in:
2023-05-25 13:09:30 +01:00
committed by GitHub
parent f19dc95826
commit ba2ce1802a
2 changed files with 62 additions and 0 deletions

41
README.md Normal file
View File

@ -0,0 +1,41 @@
# Helm Charts!
[![Release Charts](https://github.com/Thumbscrew/k8s-charts/actions/workflows/chart-releaser.yaml/badge.svg)](https://github.com/Thumbscrew/k8s-charts/actions/workflows/chart-releaser.yaml)
A repository of Helm Charts that I have deployed in my own homelab.
## 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 installed, add the repo as follows:
```bash
helm repo add thumbscrew https://thumbscrew.github.io/k8s-charts/
```
Search the repo charts:
```bash
helm search repo thumbscrew
```
## Chart Status
I will generally only maintain the charts that I am currently using. See below for which ones I'm maintaining:
|Chart Name|Description|Website|Maintained|
|----------|-----------|-------|----------|
|cinny|Cinny Matrix client|https://cinny.in/|Yes|
|freshrss|RSS reader written in PHP|https://freshrss.org/|Yes|
|pgadmin|PostgreSQL database management tool|https://www.pgadmin.org/|Yes|
|unifi-controller|Unifi Controller (using linuxserver.io's image) for managing Unifi hardware||Yes|
## Contributing
All contributions welcome!
## License
[MIT License](LICENSE)