From 98a79b1b0b73e43b5ef07bf2714c023b081b9a0e Mon Sep 17 00:00:00 2001 From: Daniel Kluge Date: Wed, 27 Jul 2022 13:28:23 +0200 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b722736..882454f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # overleaf-git-sync -A script that takes an Overleaf project and pushes it to a git remote. \ No newline at end of file +A script that takes an Overleaf project and pushes it to a git remote. +It is useable without any premium membership bs. + +## How to use +**Warning: Please be sure the TOS of the Overleaf instance you want to use allows this kind of script! I'm not responsible if you get banned and/or lose your work!** + +**I have done no testing for instances with CAPTCHA enabled. If it is, the script will most certainly not work.** + +- Install requirements +- Open `sync.py` and insert all the necessary settings +- Run `sync.py` + +When the settings are filled, it should work without user interaction, so you can run it as a cron job.