diff --git a/README.md b/README.md index 921e910f37..4ed6fd9954 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,17 @@ -**❮ NOTE ❯** This bundle releases new versions on a regular basis. Make sure -to update your dependencies frequently to get the latest version. -[Check out the changelog](https://github.com/javiereguiluz/EasyAdminBundle/releases) -to learn about the new features and read the [UPGRADE guide](https://github.com/javiereguiluz/EasyAdminBundle/blob/master/UPGRADE.md). - ------ - EasyAdmin ========= -[![Build Status](https://travis-ci.org/javiereguiluz/EasyAdminBundle.svg?branch=master)](https://travis-ci.org/javiereguiluz/EasyAdminBundle) -[![SensioLabsInsight](https://insight.sensiolabs.com/projects/a3bfb8d9-7b2d-47ab-a95f-382af395bd51/mini.png)](https://insight.sensiolabs.com/projects/a3bfb8d9-7b2d-47ab-a95f-382af395bd51) -[![Coverage Status](https://coveralls.io/repos/javiereguiluz/EasyAdminBundle/badge.svg?branch=master)](https://coveralls.io/r/javiereguiluz/EasyAdminBundle?branch=master) -[![Symfony](https://img.shields.io/badge/Symfony-%202.x%20and%203.x-green.svg "Supports Symfony 2.x and 3.x")](https://symfony.com/) +[![Tests][1]][2] [![Code Quality][3]][4] [![Code Coverage][5]][6] [![Symfony 2.x and 3.x][7]][8] + +EasyAdmin creates administration backends for your Symfony applications with +unprecedented simplicity. Symfony Backends created with EasyAdmin -EasyAdmin lets you create administration backends for Symfony applications -with unprecedented simplicity. +* [Installation](#installation) +* [Creating Your First Backend](#your-first-backend) +* [Documentation](#documentation) +* [Demo application](#demo-application) **Features** @@ -36,14 +31,9 @@ with unprecedented simplicity. Documentation ------------- -#### Getting Started Guide - -The [Getting Started Guide](Resources/doc/getting-started.md) explains how to -install the bundle and how to create your first backend. This guide is a must- -read before using EasyAdmin. - #### The Book + * [Chapter 0 - Installation and your first backend](Resources/doc/book/0-installation-and-first-backend.md) * [Chapter 1 - Basic configuration](Resources/doc/book/1-basic-configuration.md) * [Chapter 2 - Design configuration](Resources/doc/book/2-design-configuration.md) * [Chapter 3 - `list`, `search` and `show` views configuration](Resources/doc/book/3-list-search-show-configuration.md) @@ -62,7 +52,7 @@ read before using EasyAdmin. * [How to manage configuration for complex backends](Resources/doc/tutorials/complex-backend-config.md) * [Tips and tricks](Resources/doc/tutorials/tips-and-tricks.md) -#### Third-party bundles/services integrations +#### Integrations with third-party bundles/services * [How to upload files and images with VichUploaderBundle](Resources/doc/tutorials/upload-files-and-images.md) * [How to integrate FOSUserBundle to manage users](Resources/doc/tutorials/fosuserbundle-integration.md) @@ -70,8 +60,7 @@ read before using EasyAdmin. * [How To integrate FOSRestBundle and EasyAdmin](Resources/doc/tutorials/fosrestbundle-integration.md) > **❮ NOTE ❯** you are reading the documentation of the bundle's **development** -> version. You can also [read the documentation of the latest stable version ➜] -> (https://github.com/javiereguiluz/EasyAdminBundle/tree/v1.16.8/). +> version. You can also [read the documentation of the latest stable version ➜](https://github.com/javiereguiluz/EasyAdminBundle/tree/v1.16.8/). Demo Application ---------------- @@ -166,3 +155,12 @@ License ------- This software is published under the [MIT License](LICENSE.md) + +[1]: https://travis-ci.org/javiereguiluz/EasyAdminBundle.svg?branch=master +[2]: https://travis-ci.org/javiereguiluz/EasyAdminBundle +[3]: https://insight.sensiolabs.com/projects/a3bfb8d9-7b2d-47ab-a95f-382af395bd51/mini.png +[4]: https://insight.sensiolabs.com/projects/a3bfb8d9-7b2d-47ab-a95f-382af395bd51 +[5]: https://coveralls.io/repos/javiereguiluz/EasyAdminBundle/badge.svg?branch=master +[6]: https://coveralls.io/r/javiereguiluz/EasyAdminBundle?branch=master +[7]: https://img.shields.io/badge/Symfony-%202.x%20and%203.x-green.svg +[8]: https://symfony.com/ diff --git a/Resources/doc/book/0-installation-and-first-backend.md b/Resources/doc/book/0-installation-and-first-backend.md new file mode 100644 index 0000000000..0f19bdfcd4 --- /dev/null +++ b/Resources/doc/book/0-installation-and-first-backend.md @@ -0,0 +1,140 @@ +Chapter 0. Installation and Your First Backend +============================================== + +EasyAdmin Project is the new and simple admin generator for Symfony +applications. In this chapter you'll learn how to install the bundle and how to +create your first backend. + +Installation +------------ + +Installing EasyAdmin requires you to edit two files and execute two console +commands: + +### Step 1: Download the Bundle + +Open a command console, enter your project directory and execute the +following command to download the latest stable version of this bundle: + +```bash +$ composer require javiereguiluz/easyadmin-bundle +``` + +This command requires you to have Composer installed globally, as explained +in the [Composer documentation](https://getcomposer.org/doc/00-intro.md). + +### Step 2: Enable the Bundle + +Then, enable the bundle by adding it to the list of registered bundles in the +`app/AppKernel.php` file of your project: + +```php +