Skip to content

Commit f254736

Browse files
authored
Merge pull request #259 from werf/docs/update-readme
docs: update README.md
2 parents 8d05159 + f1b53e4 commit f254736

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
**Nelm** is a Helm 3 alternative. It is a Kubernetes deployment tool that manages Helm Charts and deploys them to Kubernetes. It can do (almost) everything that Helm does, but better, and even quite some on top of it. Nelm is based on improved and partially rewritten Helm 3 codebase, to introduce:
1+
**Nelm** is a Helm 3 alternative. It is a Kubernetes deployment tool that manages Helm Charts and deploys them to Kubernetes and also is the deployment engine of [werf](https://github.com/werf/werf). It can do (almost) everything that Helm does, but better, and even quite some on top of it. Nelm is based on improved and partially rewritten Helm 3 codebase, to introduce:
22

33
* `terraform plan`-like capabilities;
44
* replacement of 3-Way Merge with Server-Side Apply;
55
* secrets management;
66
* advanced resource ordering capabilities;
77
* improved resource state/error tracking;
88
* continuous printing of logs, events, resource statuses and errors during deploy;
9-
* fixes for many Helm 3 issues, e.g. ["no matches for kind Deployment in version apps/v1beta1"](https://github.com/helm/helm/issues/7219);
9+
* lots of fixes for Helm 3 bugs, e.g. ["no matches for kind Deployment in version apps/v1beta1"](https://github.com/helm/helm/issues/7219);
1010
* ... and more.
1111

1212
## Table of Contents
@@ -274,19 +274,17 @@ Nelm has powerful resource tracking built from the ground up:
274274
* Table with tracked resources current info (statuses, errors and more) printed every few seconds during deploy.
275275
* Tracking can be configured per resource with annotations.
276276

277-
<!-- add gifs -->
277+
![tracking](resources/images/nelm-release-install.gif)
278278

279279
### Printing logs and events during deploy
280280

281281
During deploy Nelm finds Pods of deployed release resources and periodically prints their container logs. Also, with annotation `werf.io/show-service-messages: "true"` resource events are printed too. Log/event printing can be tuned with annotations.
282282

283-
<!-- add gifs -->
284-
285283
### Release planning
286284

287285
`nelm release plan install` explains exactly what's going to happen in a cluster on the next release. Shows 100% accurate diffs between current and to-be resource versions, utilizing robust dry-run Server-Side Apply instead of client-side trickery.
288286
289-
<!-- add gifs -->
287+
![planning](resources/images/nelm-release-plan-install.gif)
290288
291289
### Encrypted values and encrypted files
292290
912 KB
Loading
608 KB
Loading

0 commit comments

Comments
 (0)