diff --git a/README.md b/README.md index e00ab39..f2df93e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,30 @@ Herramienta para establecer un workflow siguiendo [Conventional Commits Esta diseñada para facilitar la creación de commits y branches en un formato estandar, que permite derivar versiones automaticamente de los merges sobre ramas principales. +## Instalación + +Para instalar Git Flow, se sugiere utilizar [pipx](https://github.com/pypa/pipx) (seguir la +documentación para instalarlo). Una vez instalado `pipx`, simplemente clonamos el repositorio en una +carpeta local, y lo instalamos: + +```sh +cd ~/Downloads +git clone git@bitbucket.org:sushi2717/git-flow.git +cd git-flow +pipx install . +``` + +Luego podemos verificar que se haya instalado correctamente ejecutando: `git-flow -h` + +Para actualizarlo, hacemos un pull de los cambios recientes del repositorio, y hacemos el upgrade +mediante `pipx`: + +```sh +cd ~/Downloads/git-flow +git pull +pipx upgrade git-flow +``` + ## Configuración Para poder usar la herramienta en un repositorio, necesitamos inicializarlo: