Skip to content

Commit

Permalink
update read.me
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaszolszewski authored Jan 30, 2017
1 parent 56b2d26 commit 5fccdda
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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):
* <[email protected]> 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
* ----------------------------------------------------------------------------
*/
```

0 comments on commit 5fccdda

Please sign in to comment.