update README.md

Author: mjun0812

README.md

@@ -1,7 +1,7 @@
 # Python Copier Template
 
-[![test](https://github.com/mjun0812/python-copier-template/workflows/test/badge.svg)](https://github.com/mjun0812/python-copier-template/actions?query=workflow%3Atest)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier)
+[![Test](https://github.com/mjun0812/python-copier-template/actions/workflows/test.yml/badge.svg)](https://github.com/mjun0812/python-copier-template/actions/workflows/test.yml)
 
 A simple modern Python project template powered by [Copier](https://copier.readthedocs.io/).
 

template/README.md

@@ -1,3 +1,47 @@
 # {{project_name}}
 
 {{description}}
+
+## Development Setup
+
+After generating your project:
+
+```bash
+cd your-project-name
+
+# Install dependencies
+uv sync
+
+# Install pre-commit hooks
+uv run pre-commit install
+
+# Run tests
+uv run pytest
+
+# Run formatting and linting (automatically runs on commit)
+uv run ruff format .
+uv run ruff check .
+# Auto Fix
+uv run ruff check . --fix
+```
+
+### Docker Development
+
+The template includes a complete Docker setup:
+
+```bash
+# create uv.lock file
+uv sync
+
+# use the provided scripts
+./docker/build.sh
+./docker/run.sh # or./docker/run.sh (Command)
+
+# Build and run with Docker Compose
+docker compose build
+docker compose up
+```
+
+### VS Code Devcontainer
+
+Open the project in VS Code and use the "Reopen in Container" command for a fully configured development environment.