git-branch-clean/README.md

# Git Branch Clean

The provided code snippet represents an automated Git branch cleanup script written in JavaScript, utilizing the simple-git library. The purpose of this project is to facilitate the maintenance of a Git repository by automatically deleting merged branches that are no longer required. This script is designed to be executed periodically, cleaning up remote branches that have already been merged into the main branches (such as "test," "master," and "dev").

## Requeriments

* Git
* Nodejs

## Installation

Pull from repository.
```
$ git clone https://gitea.verdnatura.es/guillermo/git-branch-clean.git
```

Run this commands on project root directory to install Node dependencies.

```
$ npm install
```

Copy and paste the file config.yml with the name config.local.yml and put the path

## Built With

* [Git](https://git-scm.com/)
* [Nodejs](https://nodejs.org/)