chore: add README and LICENSE (#16)

.github/workflows/chart-releaser.yaml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - master
+    paths:
+      - 'charts/**'
 
 jobs:
   release-charts:
@@ -24,9 +26,9 @@ jobs:
       - name: Install Helm
         uses: azure/setup-helm@v3
         with:
-          version: v3.10.2
+          version: v3.12.0
 
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.4.1
+        uses: helm/chart-releaser-action@v1.5.0
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Thumbscrew
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

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