From c496ee77d916d46aaee066b7ce836094a688b6b1 Mon Sep 17 00:00:00 2001
From: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Date: Thu, 10 Apr 2025 17:30:54 +0300
Subject: [PATCH] Update README and .readthedocs.yaml with improved content

Expanded the README to include badges and a clearer description of the template repository. Updated the .readthedocs.yaml configuration to sync all groups during the post-install step.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
---
 .readthedocs.yaml |  2 +-
 README.md         | 15 ++++++++++++++-
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 9f084c5..89b3503 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -19,4 +19,4 @@ build:
   jobs:
     post_install:
       - pip install uv
-      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --all-groups --link-mode=copy
diff --git a/README.md b/README.md
index 7a5fd01..8938b18 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-template python package repo for open source
+[//]: # todo replace python-temp late with your package name
+[//]: # todo replace DanielAvdar with your github username
+# This is a template for creating a Python package repository for open source projects.
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-template)](https://pypi.org/project/python-template/)
+[![version](https://img.shields.io/pypi/v/python-template)](https://img.shields.io/pypi/v/python-template)
+[![License](https://img.shields.io/:license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+![OS](https://img.shields.io/badge/ubuntu-blue?logo=ubuntu)
+![OS](https://img.shields.io/badge/win-blue?logo=windows)
+![OS](https://img.shields.io/badge/mac-blue?logo=apple)
+[![Tests](https://github.com/DanielAvdar/python-template/actions/workflows/ci.yml/badge.svg)](https://github.com/DanielAvdar/python-template/actions/workflows/ci.yml)
+[![Code Checks](https://github.com/DanielAvdar/python-template/actions/workflows/code-checks.yml/badge.svg)](https://github.com/DanielAvdar/python-template/actions/workflows/code-checks.yml)
+[![codecov](https://codecov.io/gh/DanielAvdar/python-template/graph/badge.svg?token=N0V9KANTG2)](https://codecov.io/gh/DanielAvdar/python-template)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)