diff --git a/README.md b/README.md index e69de29..6b4262b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,28 @@ +# Git Pusher + +- следит за изменениями, сделанными в git репозитории +- при обнаружении изменений делает коммит со всеми файлами, подписывает текущей датой и отправляет в remote + +# Preparation + +1. Подготовьте git проект + - он должен быть проинициализирован и связан с `remote` + - `git config --global user.name` и `git config --global user.email` должны быть установлены + - установлена необходимая ветка +2. узнайте полный путь до репозитория: `pwd` +3. должны быть установлены: + - Python + - [Poetry](https://python-poetry.org) + +# Installation + +Установить systemd unit в пользовательскую область скриптом + +```bash +. install.sh -i -w +``` + +, где параметрами выступают: + +- ID - идентификатор запуска на случай, если нужно отслеживать несколько git проектов +- GIT_PATH - путь до git проекта, который нужно отслеживать \ No newline at end of file