Skip to content

Commit

Permalink
chore: README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
devcatalin authored Feb 4, 2022
1 parent 9c0b11b commit 88016f0
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
</p>

<p align="center">
<a href="https://monokle.io">Website</a> |
<a href="https://kubeshop.github.io/monokle/">Documentation</a> |
<a href="https://discord.gg/uNuhy6GDyn">Discord</a>
<a href="https://monokle.io">Website</a> |
<a href="https://kubeshop.github.io/monokle/">Documentation</a> |
<a href="https://discord.gg/uNuhy6GDyn">Discord</a> |
<a href="https://kubeshop.io/blog">Blog</a>
</p>

<p align="center">
Welcome to Monokle 🧐 - your friendly desktop UI for managing k8s manifests!
Welcome to Monokle 🧐 - your friendly desktop UI for managing k8s manifests!
</p>

<p align="center">
Expand All @@ -33,16 +34,20 @@ Welcome to Monokle 🧐 - your friendly desktop UI for managing k8s manifests!

<p align="center">
<a href="https://www.youtube.com/watch?v=wkFWg_S8eUA">
<img src="docs/img/monokle-intro-thumbnail.png" alt="Monokle Overview" />
<img src="docs/img/monokle-intro-thumbnail.png" alt="Monokle Overview" width="700" height="400" />
<p align="center">Click on the image or this link to watch the "Intro to Monokle" short video (3 mins)</p>
</a>
</p>

- Quickly get a high-level view of your manifests, their contained resources and relationships
- Easily edit resources without having to learn or look up yaml syntax
- Refactor resources with maintained integrity of names and references
- Preview and debug resources generated with kustomize or helm
- Diff resources against your cluster and apply changes immediately
- And much more, check out the [Documentation](https://kubeshop.github.io/monokle/)
## Core Features

- ⚡ Quickly get a high-level view of your manifests, their contained resources and relationships
- 🖊️ Easily edit resources without having to learn or look up yaml syntax
- 🔨 Refactor resources with maintained integrity of names and references
- 📷 Preview and debug resources generated with kustomize or helm
- 🤝 Diff resources against your cluster and apply changes immediately
- 📚 Create multi-step forms using Monokle's templating system to quickly generate manifests
- 💡 And much more, check out the [Documentation](https://kubeshop.github.io/monokle/)

Read the [Feature Overview](https://kubeshop.github.io/monokle/features/) document or the [introductory blog-post](https://medium.com/kubeshop-i/hello-monokle-83ecb42f5d96) to get a quick intro and overview.

Expand All @@ -59,11 +64,11 @@ There is a lot of functionality currently being considered:

- Creation of resources/projects - see [Resource creation/manipulation](https://github.com/kubeshop/monokle/projects/4)
- Improved Cluster functionality - see [Cluster integration](https://github.com/kubeshop/monokle/projects/8)
- Plugin/extension mechanism - see https://github.com/kubeshop/monokle/issues/177
- Plugin/extension mechanism - see [Extension mechanism for plugins](https://github.com/kubeshop/monokle/issues/177)
- Improved resource filtering/navigation - see [Resource Navigation](https://github.com/kubeshop/monokle/projects/2)
- Improved Helm integration - see [Helm integration](https://github.com/kubeshop/monokle/projects/12)

Don't hesitate provide any feedback you might have to help us prioritize and improve our backlog!
Don't hesitate to provide any feedback you might have to help us prioritize and improve our backlog!

## Getting involved

Expand Down

0 comments on commit 88016f0

Please sign in to comment.