update readme

Author: bryopsida

README.md

@@ -1,34 +1,18 @@
-# Nest.JS Starter Template
+# Patchwork
 
-## What's Included
+## What does this do?
 
-- OpenAPI/Swagger
-- Health EP `/health`
-- Helmet
-- Dockerfile
-- Helm Chart
-- GitHub Action workflows to lint, test, build image, and verify helm chart
+This inspects your statefulsets, daemonsets, deployments and checks the associated registries to see if the tag has been updated. If an update is available it triggers a rollout on that resource. This is very early in development and should not be run in production servers.
 
-## NPM Scripts
+## What are the current limitations
 
-| Syntax             | Description                                                         |
-| ------------------ | ------------------------------------------------------------------- |
-| minikube:start     | Creates a minikube cluster for testing                              |
-| minikube:stop      | Stops the minikube cluster                                          |
-| minikube:delete    | Deletes the minikube cluster                                        |
-| minikube:copyImage | Load the build image from build:image into the minikube cluster     |
-| build              | Compile the TypeScript to JavaScript                                |
-| build:image        | Build the container image                                           |
-| build:docs         | Builds the docs folder                                              |
-| start:dev          | Run the server with hot reloading on save                           |
-| start              | Start the server                                                    |
-| lint               | Check if code passes linting rules                                  |
-| lint:fix           | Automatically fix any formatting or linting rules that can be fixed |
-| helm:deploy        | Deploy the chart with the local to your cluster                     |
-| helm:uninstall     | Delete the chart release from your cluster                          |
-| helm:test          | Run the packaged tests (postman) for the helm release               |
-| test               | Run the unit tests                                                  |
+This is still very early in development and has a few limitations.
 
-## How to use published chart
+1. Does not support private registries
+2. Does not pull updates for things without `imagePullPolicy = Always`
+3. Only supports querying `linux/arm64` image repositories at the moment
+4. Only looks for updates to the same tag, IE for cases where base patches have been pushed to a tag
 
-First add the repo `helm repo add nestjs-starter  https://bryopsida.github.io/nestjs-starter/`, then fetch updates `helm repo update`, and finally, install with `helm upgrade --install starter nestjs-starter/nestjs-starter --wait`.
+## How to deploy
+
+First add the repo `helm repo add patchwork  https://bryopsida.github.io/patchwork/`, then fetch updates `helm repo update`, and finally, install with `helm upgrade --install patchwork patchwork/patchwork --wait`.