github-to-gitea-mirror/README.md

1.3 KiB

Certainly! Below is an optimized version of the README.md:


github-to-gitea-mirror

Effortlessly synchronize your GitHub repositories to Gitea. github-to-gitea-mirror seamlessly detects GitHub repositories not present on Gitea and mirrors them, ensuring your repositories are consistent across both platforms.

🚀 Setup & Usage

  1. Install required packages:
pip install python-dotenv requests
  1. Create a .env file in your project directory with the following:
GITHUB_USER=your_github_username
GITEA_USER=your_gitea_username
GITEA_TOKEN=your_gitea_token
  1. Run the script:
python your_script_name.py

🙌 Acknowledgements

  • This script was developed with guidance from Chat GPT.

🖋️ Author

Kevin Veen-Birkenbach

📜 License

Licensed under the GNU Affero General Public License v3.0. Please refer to the LICENSE file for complete details.


This optimized README is more concise and has clearer instructions for setup and usage. I've also integrated some emojis for a modern touch, which can make the README more engaging and organized.