Update README.md

README.md

@@ -1,3 +1,50 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+
+# Resource Group Automation
+
+Automatically create and manage resource groups for new repositories.
+
+## Overview
+This project provides an automated solution for managing resource groups when new repositories are created. The goal is to save time. That's it.
+
+The core functionality is implemented in `resource_group_automation.py`, which generates resource groups according to predefined rules.
+
+Have fun with the errors. They can be addicting. :-)
+
+## Features / How it works
+- Automatic resource group creation for new repositories
+- Checks if a repository exists and creates it, if it doesn't
+- Assigns the repository creator as an Admin / bossman of the new Resource Group
+- Solid error handling with informative (and fun) (and _slightly_ unprofessional) log messages
+- Comes with a built-in (well, it's a separate file) test file cleverly named `test.py`
+
+## Usage
+Run the script with:
+```bash
+python resource_group_automation.py
+```
+
+## Error Handling
+All errors are logged with descriptive messages that will make you laugh instead of cry, making debugging easier, I mean, funner. 
+
+Example log messages include:
+- "Houston, stand by: Creating repo with URL: {create_url}"
+- "Son of a Lambda Cold Start! Failed to create repository: {response.text}"
+
+## Known Limitations
+- No retry logic for API failures (future improvement)
+- Would look at more advanced features with more time
+
+## Contributing
+We welcome contributions! Please submit PRs with a clear and comedic description of your changes. Seriously, do not take yourself too seriously.
+
+## License
+This project is licensed under the MIT License.
+
+---
+
+### DEEP Fail #001
+If you're seeing `Son of a Nutcracker` in your logs... congratulations, you've discovered our **internal debugging Easter egg**.
+