Update README.md

Signed-off-by: Ritwik G <[email protected]>

Author: ritwik-g

README.md

@@ -0,0 +1,194 @@
+# Helm Values Manager
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Zipstack_helm-values-manager&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Zipstack_helm-values-manager)
+[![Build Status](https://github.com/Zipstack/helm-values-manager/actions/workflows/test.yml/badge.svg)](https://github.com/Zipstack/helm-values-manager/actions/workflows/test.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Zipstack/helm-values-manager/main.svg)](https://results.pre-commit.ci/latest/github/Zipstack/helm-values-manager/main)
+[![Security](https://github.com/Zipstack/helm-values-manager/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Zipstack/helm-values-manager/actions/workflows/github-code-scanning/codeql)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Zipstack_helm-values-manager&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Zipstack_helm-values-manager)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=Zipstack_helm-values-manager&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=Zipstack_helm-values-manager)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Zipstack_helm-values-manager&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Zipstack_helm-values-manager)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Zipstack_helm-values-manager&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Zipstack_helm-values-manager)
+
+🚀 A powerful Helm plugin for managing values and secrets across multiple environments.
+
+## The Problem
+
+Managing Helm values across multiple environments (dev, staging, prod) is challenging:
+
+- 🔀 **Values Sprawl**: Values spread across multiple files become hard to track
+- 🔍 **Configuration Discovery**: Difficult to know what values can be configured
+- ❌ **Missing Values**: No validation for required values before deployment
+- 🔐 **Secret Management**: Sensitive data mixed with regular values
+- 📝 **Documentation**: Values often lack descriptions and context
+
+Helm Values Manager solves these challenges by providing a structured way to define, validate, and manage values across environments, with built-in support for documentation and secret handling.
+
+## Features
+
+- 🔐 **Secure Secret Management**: Safely handle sensitive data
+- 🌍 **Multi-Environment Support**: Manage values for dev, staging, prod, and more
+- 🔄 **Value Inheritance**: Define common values and override per environment
+- 🔍 **Secret Detection**: Automatically identify and protect sensitive data
+- 📦 **Easy Integration**: Works seamlessly with existing Helm workflows
+
+## Requirements
+
+- Python 3.9 or higher
+- Helm 3.x
+- pip (Python package installer)
+
+## Installation
+
+```bash
+helm plugin install https://github.com/Zipstack/helm-values-manager --version v0.1.0
+```
+
+## Quick Start
+
+1. Initialize a new configuration for your Helm release:
+
+```bash
+helm values-manager init --release my-app
+```
+
+2. Add value configurations with descriptions and validation:
+
+```bash
+# Add a required configuration
+helm values-manager add-value-config --path app.replicas --description "Number of application replicas" --required
+
+# Add an optional configuration
+helm values-manager add-value-config --path app.logLevel --description "Application log level (debug/info/warn/error)"
+```
+
+3. Add deployments for different environments:
+
+```bash
+helm values-manager add-deployment dev
+helm values-manager add-deployment prod
+```
+
+4. Set values for each deployment:
+
+```bash
+# Set values for dev
+helm values-manager set-value --path app.replicas --value 1 --deployment dev
+helm values-manager set-value --path app.logLevel --value debug --deployment dev
+
+# Set values for prod
+helm values-manager set-value --path app.replicas --value 3 --deployment prod
+helm values-manager set-value --path app.logLevel --value info --deployment prod
+```
+
+5. Generate values files for deployments:
+
+```bash
+# Generate dev values
+helm values-manager generate --deployment dev --output ./dev
+
+# Generate prod values
+helm values-manager generate --deployment prod --output ./prod
+```
+This will create environment-specific values files:
+
+`dev/dev.my-app.values.yaml`:
+```yaml
+app:
+  logLevel: debug
+  replicas: '1'
+```
+
+`prod/prod.my-app.values.yaml`:
+```yaml
+app:
+  logLevel: info
+  replicas: '3'
+```
+
+6. View available commands and options:
+
+```bash
+helm values-manager --help
+```
+
+## Development
+
+### Setup Development Environment
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/zipstack/helm-values-manager
+cd helm-values-manager
+```
+
+2. Create and activate a virtual environment:
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: .\venv\Scripts\activate
+```
+
+3. Install development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+4. Install pre-commit hooks:
+
+```bash
+pre-commit install
+```
+
+### Running Tests
+
+Run tests with tox (will test against multiple Python versions):
+
+```bash
+tox
+```
+
+Run tests for a specific Python version:
+
+```bash
+tox -e py39  # For Python 3.9
+```
+
+### Code Quality
+
+This project uses several tools to maintain code quality:
+
+- **pre-commit**: Runs various checks before each commit
+- **black**: Code formatting
+- **isort**: Import sorting
+- **flake8**: Style guide enforcement
+
+Run all code quality checks manually:
+
+```bash
+pre-commit run --all-files
+```
+
+## Contributing
+
+🙌 PRs and contributions are welcome! Let's build a better Helm secret & config manager together.
+
+Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project.
+
+## Acknowledgments
+
+We would like to acknowledge the following AI tools that have helped in the development of this project:
+
+- **[Windsurf IDE with Cascade](https://codeium.com/windsurf)**: For providing intelligent code assistance and pair programming capabilities. Also for helping with improving and documenting the architecture.
+- **[Software Architect GPT](https://chatgpt.com/g/g-J0FYgDhN5-software-architect-gpt)**: For initial architectural guidance and design decisions.
+
+While these AI tools have been valuable in our development process, all code and design decisions have been carefully reviewed and validated by our development team to ensure quality and security.
+
+## 📌 License
+
+🔓 Open-source under the [MIT License](LICENSE).
+
+### 🌟 Star this repo if you find it useful! 🌟
+
+[![Star](https://img.shields.io/github/stars/zipstack/helm-values-manager?style=social)](https://github.com/zipstack/helm-values-manager)