Update README.md to include additional badges and enhance quick start instructions

This commit is contained in:
Arunavo Ray
2025-05-19 19:21:53 +05:30
parent 645006afe3
commit 38206e7d3d

View File

@@ -1,11 +1,26 @@
# Gitea Mirror
<!-- Badges -->
<p align="center">
<a href="https://github.com/arunavo4/gitea-mirror/releases/latest"><img src="https://img.shields.io/github/v/tag/arunavo4/gitea-mirror?label=release"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/actions/workflows/astro-build-test.yml"><img src="https://img.shields.io/github/actions/workflow/status/arunavo4/gitea-mirror/astro-build-test.yml?branch=main"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/pkgs/container/gitea-mirror"><img src="https://img.shields.io/badge/ghcr.io-container-blue?logo=github"/></a>
<a href="https://github.com/arunavo4/gitea-mirror/blob/main/LICENSE"><img src="https://img.shields.io/github/license/arunavo4/gitea-mirror"/></a>
</p>
# Gitea Mirror
<p align="center">
<i>A modern web application for automatically mirroring repositories from GitHub to your self-hosted Gitea instance.</i><br>
<sub>Designed for developers, teams, and organizations who want to retain full control of their code while still collaborating on GitHub.</sub>
</p>
## 🚀 Quick Start
```bash
docker compose --profile production up -d
# or
pnpm setup && pnpm dev
```
<p align="center">
<img src=".github/assets/dashboard.png" alt="Dashboard" width="80%"/>
</p>