Update readme md

Author: utdevnp

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Utsha B Luitel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

README.md

@@ -1,8 +1,26 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# KubeDiff
+
+KubeDiff is a simple and efficient tool designed to help you compare workloads, ConfigMaps, and Key Vault secrets across multiple Kubernetes clusters and environments (such as dev, stage, UAT, etc.).
+
+## Story Behind Creating KubeDiff
+
+While working with multiple Kubernetes clusters and environments, I often needed to switch between workloads and check Key Vault secrets and ConfigMaps. Comparing workloads across different environments (e.g., dev, stage, UAT) was time-consuming and sometimes confusing. To make this process more convenient and efficient, I created KubeDiff.
+
+KubeDiff aims to simplify the comparison process, making it easier for users to manage and verify their Kubernetes resources across various environments with confidence and ease.
+
+## Features
+- **Compare Workloads**: Directly compare deployments and workloads across environments.
+- **Compare Key Vaults**: Easily view and compare secrets stored in Key Vaults between clusters or namespaces.
+- **Compare ConfigMaps**: Effortlessly compare ConfigMaps across different environments.
+- **User-Friendly Interface**: Intuitive design for a smooth user experience.
+- **Multi-Cluster Support**: Easily switch and compare resources across multiple Kubernetes clusters.
+- **Quick Insights**: Instantly identify differences and similarities between environments.
+
+> **Note:** All comparisons are performed within the environments and clusters you specify and select. Please ensure you have chosen the correct environment for accurate results.
 
 ## Getting Started
 
-First, run the development server:
+To run the development server:
 
 ```bash
 npm run dev
@@ -14,24 +32,20 @@ pnpm dev
 bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
 
-## Learn More
+## How to Contribute
 
-To learn more about Next.js, take a look at the following resources:
+We welcome contributions! To contribute:
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+Thank you for considering contributing to KubeDiff!
 
-## Deploy on Vercel
+## License
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
-# KubeDiff
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.