docs: Add comprehensive README with PR contribution instructions

- Add complete project overview and description
- Include step-by-step guide for adding yourself via PR
- Document YAML file format with required/optional fields
- Provide real-world examples of user profiles
- Add local development setup instructions
- Include troubleshooting section and FAQ
- Document contribution guidelines and CI/CD process

Fixes #213

Author: Subham-KRLX