diff --git a/README.md b/README.md index e8c58d5..ec7ff1b 100644 --- a/README.md +++ b/README.md @@ -5,5 +5,38 @@ ![Docker Build](https://img.shields.io/docker/cloud/build/trydirect/orocommerce.svg) [![Gitter chat](https://badges.gitter.im/trydirect/community.png)](https://gitter.im/try-direct/community) -# orocommerce -Deploy OROCommerce with docker-compose +## Note +Before installing this project, please, make sure you have installed docker and docker-compose + +To install docker execute: +```sh +$ curl -fsSL https://get.docker.com -o get-docker.sh +$ sh get-docker.sh +$ pip install docker-compose +``` + +# OROCommerce + +The goal of this project is to give possibility to setup OROCommerce development environment as easy as it possible. + +# Installation +Clone this project into your work directory: +```sh +$ git clone "https://github.com/trydirect/orocommerce.git" +$ cd orocommerce +``` +Run stack with: +```sh +$ docker-compose up -d +``` +## Contributing + +1. Fork it (https://github.com/trydirect/orocommerce/fork) +2. Create your feature branch (git checkout -b feature/fooBar) +3. Commit your changes (git commit -am 'Add some fooBar') +4. Push to the branch (git push origin feature/fooBar) +5. Create a new Pull Request + +## Support Development + +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2BH8ED2AUU2RL)