Merge pull request #19 from jordojordo/main

Update Readme

README.md

@@ -2,5 +2,92 @@
 
 This repository contains Helm charts for official UI Plugins (Extensions) from Rancher
 
+## Contributing
+
+### Requirements
+
+* Charts must be Helm 3 compatible.
+
+* Chart must be **published** in a **public Github** repository that we can reference.
+
+### Workflow
+
+#### 1. Fork the [UI Plugin Charts](https://github.com/rancher/ui-plugin-charts) repository, clone your fork, checkout the **main** branch and pull the latest changes. 
+Then create a new branch off of main
+
+#### 2. Update the `manifest.json` with your Extension metadata.
+
+```json
+{
+  "extensions": {
+    "kubewarden": {
+      "repo": "kubewarden/ui",
+      "branch": "gh-pages",
+      "versions": [
+        "1.0.0",
+        "1.1.0"
+      ]
+    }
+  }
+}
+```
+
+#### 3. Commit your changes
+```bash
+git add manifest.json
+git commit -m "Submitting kubewarden/ui version 1.1.0"
+```
+
+#### 4. Push your commit
+```bash
+git push origin <your_branch>
+```
+
+#### 5. Open a pull request on the **main** branch
+
+Once your pull request is approved and merged, an automated workflow will sync this repository with the build assets from the supplied repository within the `manifest.json` file. When fully synced, a new release will be created and added to the [releases](https://github.com/rancher/ui-plugin-charts/releases) section. 
+
+### Configuration File
+
+Required properties for `manifest.json`
+| Variable | Description |
+| ------------- |------------- |
+| [extension key] | This name is representative of the Extension **package** name. For example, the [clock](https://github.com/rancher/ui-plugin-examples/tree/main/pkg/clock) package within the [`ui-plugin-examples`](https://github.com/rancher/ui-plugin-examples/tree/main) repository, `clock` would be the extension key.
+| repo | Defines the upstream **Github** repository to pull the build assets from.
+| branch | Defines which branch to pull from the upstream `repo`
+| versions | An array of version strings which correspond to the Extension **package** version(s) to be synced with this repository. For example, the [clock](https://github.com/rancher/ui-plugin-examples/tree/main/charts/clock) extension package has two versions, `0.1.0` and `0.2.0` would be added.
+
+
+### Examples
+
+```json
+{
+  "extensions": {
+    "elemental": {
+      "repo": "rancher/elemental-ui",
+      "branch": "main",
+      "versions": [
+        "1.2.0",
+        "1.1.0",
+        "1.0.0"
+      ]
+    },
+    "kubewarden": {
+      "repo": "kubewarden/ui",
+      "branch": "gh-pages",
+      "versions": [
+        "1.0.0",
+        "1.0.1",
+        "1.0.2",
+        "1.0.3",
+        "1.0.4",
+        "1.0.5",
+        "1.0.6",
+        "1.1.0"
+      ]
+    }
+  }
+}
+```