From b7eaa94ca2a06f2013bda838d1dbaa657da51614 Mon Sep 17 00:00:00 2001 From: Arunavo Ray Date: Wed, 21 May 2025 14:32:34 +0530 Subject: [PATCH] Update README for improved structure and clarity --- README.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 4e8d811..739c252 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,29 @@

- Gitea Mirror Logo -

- - -

- - - - -

- -# Gitea Mirror - -

- A modern web application for automatically mirroring repositories from GitHub to your self-hosted Gitea instance.
- Designed for developers, teams, and organizations who want to retain full control of their code while still collaborating on GitHub. + Gitea Mirror Logo +

Gitea Mirror

+

A modern web app for automatically mirroring repositories from GitHub to your self-hosted Gitea.

+

+ release + build + container + license +

## 🚀 Quick Start ```bash -# Using Docker (recommended for most users) +# Using Docker (recommended) docker compose --profile production up -d -# Using Bun directly +# Using Bun bun run setup && bun run dev -# Using LXC container on Proxmox (for homelab setups) +# Using LXC on Proxmox curl -fsSL https://raw.githubusercontent.com/arunavo4/gitea-mirror/main/scripts/gitea-mirror-lxc-installer.sh | bash -``` +```` -See the [LXC Container Deployment Guide](scripts/README-lxc.md) for detailed instructions on deploying with Proxmox LXC containers. +See the [LXC Container Deployment Guide](scripts/README-lxc.md).

Dashboard