Skip to content

Commit

Permalink
docs: revise docs for dolphin
Browse files Browse the repository at this point in the history
  • Loading branch information
damienwebdev committed Aug 4, 2022
1 parent 263a4b5 commit 81019ab
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Get rid of your "it works on my machine" arguments.
This project intends to create an opinionated, performant, replicable, and production-like Magento 2 local development environment that leverages Docker.
This project intends to create an opinionated, performant, replicable, and production-like Magento 2 local development environment that leverages [Docker](https://www.docker.com/), [VSCode](https://code.visualstudio.com/) and [devcontainers](https://code.visualstudio.com/docs/remote/containers).

[![graycore/magento2-php pulls](https://img.shields.io/docker/pulls/graycore/magento-php.svg?label=magento-php%20docker%20pulls)](https://hub.docker.com/r/graycore/magento-php)
[![Mage2Docker Commit Activity](https://img.shields.io/badge/maintained%3F-yes-brightgreen.svg)](https://github.com/graycoreop/mage2docker/graphs/commit-activity)
Expand All @@ -20,33 +20,37 @@ This project intends to create an opinionated, performant, replicable, and produ
|-----------------|---------------------|---------------------|
| 2.2.* | N/A | Dec 2019 |
| <2.3.7 | v4.1.0 | Apr 2022 |
| >=2.3.7 | v5.0.0 | Apr 2022 |
| >=2.3.7 | >v5.0.0 | Apr 2022 |
| 2.4.0 | v4.1.0 | Nov 2022 |
| 2.4.1 | v4.1.0 | Nov 2022 |
| 2.4.2 | v5.0.0 | Nov 2022 |
| 2.4.3 | v5.0.0 | Nov 2022 |
| 2.4.2 | >v5.0.0 | Nov 2022 |
| 2.4.3 | >v5.0.0 | Nov 2022 |

## Getting Started
To get started, pick your operating system from the list below. Don't see yours? [Make an issue.](https://github.com/graycoreio/mage2docker/issues/new?assignees=damienwebdev&labels=feat&template=feature_request.md&title=%5BFEAT%5D)
### Dolphin
As of Mage2Docker v6.0.0, Dolphin is the new fully cross-platform Mage2docker environment that leverages VSCode `devcontainers` or Github Codespaces.

## Supported Platforms
* [Windows via WSL2](./docs/platforms/windows.md)
* [MacOS](./docs/platforms/macos.md)
* [Linux - Ubuntu](./docs/platforms/ubuntu.md)
To get started, see [the new significantly smoother installation process. We strongly encourage you to use it](./docs/stories/dolphin.md).

For those users curious on why we've made these changes, [please read the architecture discussion.](./docs/arch/dolphin.md)

## Prerequisites

#### Hardware
* 16GB RAM
* 4 Cores
* 4GB RAM
* 2 Cores

## Features

* :clock1: [**5 Minute** Setup](#supported-platforms)
* :octocat: Bring your own repo (BYOR)
* :biohazard: Use Magento Source Code
* :violin: Using [Composer](https://getcomposer.org/)
* :fire: Fast (~250ms Response Times Out-of-the-box)
* :evergreen_tree: Alpine Linux
* :grin: [Semver Compliant](https://semver.org/)
* :lock: [Local TLS Certificates](./docs/stories/ssl/making-tls-work-locally.md)
* :gear: [Infinitely Configurable](./docs/stories/configuring.md)
* Magento 2 Open Source & Commerce (Not Cloud) Support
* If you're using cloud, please use the ["Cloud Docker" project created by Adobe](https://devdocs.magento.com/cloud/docker/docker-config.html)
* :lock: [Local TLS Certificates](./docs/stories/ssl/making-tls-work-locally.md)
* :gear: [Infinitely Configurable](./docs/stories/configuring.md)
* [VSCode](https://code.visualstudio.com/)
* [Codespaces ready](https://github.com/features/codespaces)

0 comments on commit 81019ab

Please sign in to comment.