diff --git a/README.md b/README.md index 60124d5..707a649 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,26 @@ # EZCompose ![visitors](https://visitor-badge.glitch.me/badge?page_id=ezcompose) ![Pylint](https://github.com/xe-nvdk/ezcompose/workflows/Pylint/badge.svg) -EZCompose es un programa en Python que mediante un asistente te ayuda a generar un archivo docker-compose.yml. En este video, pueden ver [cómo funciona EZCompose](https://youtu.be/nCqUx_3D7mQ?t=100). +EZCompose is a docker-compose.yml builder. Define your images, networks, volumes, ports and more, easily. In this video (Spanish) you can see how [EZCompose works](https://youtu.be/nCqUx_3D7mQ?t=100). -## Preguntas Frecuentes +## FAQ -### Como ejecuto EZCompose - -Para ejecutar EZCompose, si estás en Linux, descargas el ejecutable que encontrarás en [releases](https://github.com/xe-nvdk/ezcompose/releases), si no quieres ejecutarlo desde el ejecutable y quieres lanzar el script de Python, usa el que esta especificado en el release, ya que el de repositorio se esta tocando todo el tiempo y puede no funcionar. - -Si usas código fuente descargado desde el release, necesitas instalar Python3 en tu sistema, Si no lo tienes, ejecutas: +### How should I run EZCompose? +In each release, you have a executable file to run EZCompose under Linux or MacOS. ``` -$ sudo apt-get install python3 +$ ./ezcompose ``` -Si estás en Windows, te recomiendo que lo bajes desde la [página oficial](https://www.python.org/downloads/). +If you're a Windows user, you need to download the source code and run in the following way. -Una vez que instalaste, descargas la última versión de EZCompose y ejecutas lo siguiente: ``` -python3 ezcompose.py +$ python3 ezcompose.py ``` -A partir de ahí, deberías ver la pantalla de bienvenida +If you don't have installed Python, you can download it from [[here](https://www.python.org/downloads/). +Since the v0.1.5, EZCompose can be run from a Docker Container, you only need to run... ``` -############################################################## -################ Bienvenides a EZCompose ##################### -############################################################## - -Este programa te ayudará a crear un archivo docker-compose.yml - -Escribe el nombre del servicio: +$ docker run -it hectorivand/ezcompose:v0.1.5 ``` -### Le faltan opciones a EZCompose - -Si, eso es correcto, a la fecha que estoy escribiendo esto, (Noviembre 2020) EZCompose es capaz de generar un archivo docker-compose.yml totalmente funcional, pero es bastante limitado, solo podés agregar un solo juego de puertos, un solo volumen, una sola label, etc. La idea es que a medida que siga aprendiendo Python, tenga más funcionalidades y alcance un grado "Production Ready". -### Che, me gustaría contribuir +### I want to contribute with EZCompose -Si te copa el proyecto y te gustaría contribuir, ningún problema, todas las contribuciones son bienvenidas. Simplemente hace un Fork de este repo y cuando tengas esa modificación hecha, hace un Pull Request. +If you like this project and you want to contribute, you're very welcome to do it, just fork it and make a pull request when you're ready. Here, you can see the the [To Do list](https://github.com/xe-nvdk/ezcompose/projects/1) and here the [Issues](https://github.com/xe-nvdk/ezcompose/issues).