From 5fccdda5ed8ac682634df4e2d6bd79fa9165ccf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Olszewski?= Date: Mon, 30 Jan 2017 12:33:32 +0100 Subject: [PATCH] update read.me --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 4ccea2d..f1dc43e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # mage2docker + Mage2Docker - Plugin for Oh-My-Zsh + +## Description + +Plugin for Oh-My-Zsh bash that makes it easy to work with Docker and Magento 2. It allow to do simply and faster common commands like clean cache, setup upgrade, compile di and much more in Magento 2 on container. + +## Demo + +![alt tag](https://raw.githubusercontent.com/lukaszolszewski/mage2docker/master/static/mage2docker.gif) + +## Requirements + +- Docker +- Oh-My-Zsh [www](https://github.com/robbyrussell/oh-my-zsh) + +## Instalation + +- Clone a repository to **~/.oh-my-zsh/custom/plugins** +- In the file **~/.zshrc**, add an entry **plugins=(mage2docker)** + +## License +``` +/* + * ---------------------------------------------------------------------------- + * "THE BEER-WARE LICENSE" (Revision 42): + * wrote this file. As long as you retain this notice you + * can do whatever you want with this stuff. If we meet some day, and you think + * this stuff is worth it, you can buy me a beer in return Poul-Henning Kamp + * ---------------------------------------------------------------------------- + */ + ```