Skip to content

Commit

Permalink
docs(all): update readme for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
damienwebdev committed Jun 1, 2020
1 parent 03a754a commit 743a16d
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
This project intends to create a performant, replicable, and production-like Magento 2 local development environment that leverages Docker.

<div align="center">
<a href="https://github.com/magento/magento2" target="_blank">
<img src="https://img.shields.io/badge/magento-2.X-brightgreen.svg?logo=magento&amp;longCache=true"
alt="Supported Magento Versions">
</a>
<a href="https://hub.docker.com/r/graycore/magento-php" target="_blank">
<img src="https://img.shields.io/docker/pulls/graycore/magento-php.svg?label=magento-php%20docker%20pulls"
alt="Docker Hub Pulls - Magento php">
Expand All @@ -20,7 +16,20 @@ This project intends to create a performant, replicable, and production-like Mag
<a href="https://github.com/graycoreop/mage2docker/graphs/commit-activity" target="_blank"><img src="https://img.shields.io/badge/maintained%3F-yes-brightgreen.svg" alt="Maintained - Yes" /></a>
<a href="https://github.com/graycore/mage2docker/blob/master/LICENSE.md" target="_blank"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT"/></a>
<a href="https://gitter.im/graycoreio/mage2docker" target="_blank"><img src="https://img.shields.io/badge/chat-%23mage2docker%20on%20Gitter-brightgreen.svg" alt="Chat with Mage2Docker on Gitter"/></a>

</div>
<div align="center">
<a href="https://github.com/magento/magento2" target="_blank">
<img src="https://img.shields.io/badge/magento-2.X-brightgreen.svg?logo=magento&amp;longCache=true"
alt="Supported Magento Versions">
</a>
<a href="https://github.com/magento/magento2" target="_blank">
<img src="https://img.shields.io/badge/magento-commerce-brightgreen.svg?logo=magento&amp;longCache=true"
alt="Supports Magento Commerce">
</a>
<a href="https://github.com/magento/magento2" target="_blank">
<img src="https://img.shields.io/badge/magento-opensource-brightgreen.svg?logo=magento&amp;longCache=true"
alt="Supports Magento Open Source">
</a>
</div>

## Prerequisites
Expand All @@ -43,25 +52,14 @@ This project intends to create a performant, replicable, and production-like Mag

* :clock1: **5 Minute** Setup
* :fire: Fast (~250ms Out-of-the-box)
* :tada: Blackfire Performance Profiling
* :evergreen_tree: Alpine Linux
* :lock: Local SSL Certificates

## Use Cases (User Stories)

We intend to support the following common use cases:

* [Working with an existing Magento 2 Project](./docs/stories/existing-project.md)
* [Starting a new Magento 2 Project](./docs/stories/new-project.md)
* [Building Extensions for Magento as composer packages](./docs/stories/extensions.md)
* [Running Unit and Integration Tests](./docs/stories/testing.md)
* [Complete Teardown and Reinstall](./docs/stories/reinstalling.md)
* [Using Blackfire Profiler to run performance tests](./docs/stories/blackfire.md)
* [Autocomplete Support during Local Development](./docs/stories/autocomplete.md)

## Frequently Asked Questions

To avoid unnecessary Issues, there is documentation on commonly asked questions:

* [What commands do I need to know and where are they run?]()
* [Why are there two places to run composer?]()
* [Glossary of Terms]()
* [Adding Local SSL Certificates](./docs/stories/ssl/making-tls-work-locally.md)

0 comments on commit 743a16d

Please sign in to comment.