docs: update usage docs

DEVELOPMENT.md

@@ -0,0 +1,14 @@
+## Development
+
+### Prerequisites
+
+- [Helm](https://helm.sh/docs/intro/install/)
+- [Helm Docs](https://github.com/norwoodj/helm-docs)
+- [Pre-commit](https://pre-commit.com/index.html#installation)
+
+### Install pre-commit hooks
+
+ ```sh
+  pre-commit install
+  pre-commit install-hooks
+ ```

LICENSE

@@ -0,0 +1,19 @@
+# The Clear BSD License
+
+Copyright 2023 Virtru Corporation
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below)
+provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Virtru Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without
+  specific prior written permission.
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE

README.md

@@ -1,20 +1,32 @@
+<p align="center">
+    <img width="200px" height=auto src="https://avatars.githubusercontent.com/u/90051847?s=280&v=4" />
+</p>
+
+<p align="center">
+    <a href="https://join.slack.com/t/opentdf/shared_invite/zt-2h6j6n5ly-BVUq~bIPoMeSu~20XQswFw"><img src="https://img.shields.io/badge/Join%20Our%20Community-Slack-blue" /></a>
+    <a href="https://github.com/opentdf/charts"><img src="https://badgen.net/github/stars/opentdf/charts?icon=github" /></a>
+    <a href="https://github.com/opentdf/charts"><img src="https://badgen.net/github/forks/opentdf/charts?icon=github" /></a>
+    <!-- <a href="https://artifacthub.io/packages/search?repo=opentdf"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/opentdf" /></a> -->
+    <a href="https://github.com/opentdf/charts/actions/workflows/chart-releaser.yaml"><img src="https://github.com/opentdf/charts/actions/workflows/chart-releaser.yaml/badge.svg" /></a>
+</p>
+
 # OpenTDF Helm Charts
 
-## Charts
+## Usage
 
-- [Platform](charts/platform/README.md)
+[Helm](https://helm.sh) must be installed to use the charts.  Please refer to
+Helm's [documentation](https://helm.sh/docs) to get started
 
-## Development
+Once Helm has been set up correctly, add the repo as follows:
 
-### Prerequisites
+    helm repo add opentdf https://opentdf.github.io/charts
 
-- [Helm](https://helm.sh/docs/intro/install/)
-- [Helm Docs](https://github.com/norwoodj/helm-docs)
-- [Pre-commit](https://pre-commit.com/index.html#installation)
+If you had already added this repo earlier, run `helm repo update` to retrieve
+the latest versions of the packages.  You can then run `helm search repo
+opentdf` to see the charts.
 
-### Install pre-commit hooks
+For chart specific documentation, please refer to the README.md files in the respective chart directories.
 
- ```sh
-  pre-commit install
-  pre-commit install-hooks
- ```
+### Charts
+
+- [Platform](charts/platform/README.md)

charts/platform/README.md

@@ -1,6 +1,6 @@
 # platform
 
-![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
+![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
 
 A Helm Chart for OpenTDF Platform
 
@@ -9,10 +9,10 @@ A Helm Chart for OpenTDF Platform
 In order to run the platform you need a supported identity provider and postgres database. We have included the following charts as dependencies:
 
 - [Keycloak](https://www.keycloak.org/guides)
-  - <https://artifacthub.io/packages/helm/bitnami/keycloak>
+  - [Helm Chart](https://artifacthub.io/packages/helm/bitnami/keycloak)
 
 - [Postgres](https://www.postgresql.org/)
-  - <https://artifacthub.io/packages/helm/bitnami/postgresql>
+  - [Helm Chart](https://artifacthub.io/packages/helm/bitnami/postgresql)
 
 If you want to deploy keycloak and postgresql as part of the platform deployment make sure to follow [Playground Configuration](#playground-configuration-optional) section.
 

charts/platform/README.md.gotmpl

@@ -119,4 +119,4 @@ grpcurl -insecure $PLATFORM_HOST:443 kas.AccessService/PublicKey
 
 {{ template "chart.requirementsSection" . }}
 
-{{ template "chart.valuesSection" . }}
+{{ template "chart.valuesSection" . }}