Adjust README.md structure and content (#459)

* Adjust README.md structure and content

* Minor wording adjustments

* Reword elasticsearch section

* Remove full stop in composer.json

* Minor wording adjustments

.github/workflows/test-application.yaml

@@ -1,30 +1,41 @@
 name: Test application
 
-on: pull_request
+on:
+    pull_request:
+    push:
+        branches:
+            - master
 
 jobs:
     php-cs-fixer:
         name: Run php-cs-fixer
         runs-on: ubuntu-18.04
+
         steps:
             - name: Checkout project
               uses: actions/checkout@v1
+
             - name: Create downloads directory
               run: mkdir downloads
+
             - name: Get downloads path
               id: php-cs-fixer-dir
               run: echo "::set-output name=dir::downloads"
+
             - name: Get php-cs-fixer path
               id: php-cs-fixer-path
               run: echo "::set-output name=path::${{ steps.php-cs-fixer-dir.outputs.dir }}/php-cs-fixer.phar"
+
             - name: Cache php-cs-fixer
               id: php-cs-fixer-cache
               uses: actions/cache@v1
               with:
                   path: ${{ steps.php-cs-fixer-dir.outputs.dir }}
                   key: php-cs-fixer
+
             - name: Download php-cs-fixer
               if: steps.php-cs-fixer-cache.outputs.cache-hit != 'true'
               run: curl "https://cs.symfony.com/download/php-cs-fixer-v2.phar" --output ${{ steps.php-cs-fixer-path.outputs.path }} && chmod +x ${{ steps.php-cs-fixer-path.outputs.path }}
+
             - name: Run php-cs-fixer
               run: ./${{ steps.php-cs-fixer-path.outputs.path }} fix --dry-run --diff

README.md

@@ -1,47 +1,97 @@
-# SuluArticleBundle
+<h1 align="center">SuluArticleBundle</h1>
 
-[![Build Status](https://travis-ci.org/sulu/SuluArticleBundle.svg?branch=master)](https://travis-ci.org/sulu/SuluArticleBundle/branches)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sulu/SuluArticleBundle/badges/quality-score.png)](https://scrutinizer-ci.com/g/sulu/SuluArticleBundle/)
-[![Code Coverage](https://scrutinizer-ci.com/g/sulu/SuluArticleBundle/badges/coverage.png)](https://scrutinizer-ci.com/g/sulu/SuluArticleBundle/)
-[![StyleCI](https://styleci.io/repos/61883398/shield)](https://styleci.io/repos/61883398)
+<p align="center">
+    <a href="https://sulu.io/" target="_blank">
+        <img width="30%" src="https://sulu.io/uploads/media/800x/00/230-Official%20Bundle%20Seal.svg?v=2-6&inline=1" alt="Official Sulu Bundle Badge">
+    </a>
+</p>
 
-The SuluArticleBundle adds support for managing articles in Sulu. Articles can be used in a lot of different ways to
-manage unstructured data with an own URL in an admin-list. Most of the features, which can be used in pages, can also
-be used on articles - like templates, versioning, drafting, publishing and automation.
+<p align="center">
+    <a href="https://github.com/sulu/SuluArticleBundle/blob/master/LICENSE" target="_blank">
+        <img src="https://img.shields.io/github/license/sulu/SuluArticleBundle.svg" alt="GitHub license">
+    </a>
+    <a href="https://github.com/sulu/SuluArticleBundle/releases" target="_blank">
+        <img src="https://img.shields.io/github/tag/sulu/SuluArticleBundle.svg" alt="GitHub tag (latest SemVer)">
+    </a>
+    <a href="https://github.com/sulu/SuluArticleBundle/actions" target="_blank">
+        <img src="https://img.shields.io/github/workflow/status/sulu/SuluArticleBundle/Test%20application/master.svg?label=github-actions" alt="GitHub actions status">
+    </a>
+    <a href="https://travis-ci.org/sulu/SuluArticleBundle/branches" target="_blank">
+        <img src="https://img.shields.io/travis/sulu/SuluArticleBundle/master.svg?label=travis" alt="Travis build">
+    </a>
+    <a href="https://circleci.com/gh/sulu/SuluArticleBundle/tree/master" target="_blank">
+        <img src="https://img.shields.io/circleci/build/github/sulu/SuluArticleBundle/master.svg?label=circleci" alt="CircleCI build">
+    </a>
+    <a href="https://github.com/sulu/sulu/releases" target="_blank">
+        <img src="https://img.shields.io/badge/sulu%20compatibility-%3E=2.0-52b6ca.svg" alt="Sulu compatibility">
+    </a>
+</p>
+<br/>
 
-Additional features included:
+The **SuluArticleBundle** integrates a performance optimized way for managing articles in the [Sulu](https://sulu.io/) 
+content management system. In the context of this bundle, **articles are localized content-rich entities** that are 
+**manageable via the Sulu administration interface** and can be **rendered on a website delivered by Sulu**. 
+This makes them a good choice for managing things like blog posts, products or even recipes in a Sulu project. 
+In order to keep things clean, the bundle allows to **manage different types of articles via separated lists** in the 
+administration interface.
 
-* Build in view-layer with elasticsearch
-* Segmentation of article-templates (called article-types)
-* Define URL schemas per type
+<br/>
+<p align="center">
+    <img width="80%" src="https://sulu.io/uploads/media/800x@2x/05/235-ezgif.gif?v=1" alt="Sulu Slideshow">
+</p>
+<br/>
 
-## Requirements
+The SuluArticleBundle is compatible with Sulu **starting from version 2.0**. Have a look at the `require` section in 
+the [composer.json](https://github.com/sulu/SuluArticleBundle/blob/master/composer.json) to find an 
+**up-to-date list of the requirements** of the bundle.
 
-* Composer
-* PHP `^7.2`
-* Sulu `^2.0.1`
-* Elasticsearch `~5.0 || ~6.0`
 
-For detailed requirements see [composer.json](https://github.com/sulu/SuluArticleBundle/blob/master/composer.json).
+## 🚀&nbsp; Installation and Documentation
 
-## Documentation
+Execute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your 
+project:
 
-The the Documentation is stored in the
-[Resources/doc/](https://github.com/sulu/SuluArticleBundle/blob/master/Resources/doc) folder.
+```bash
+composer require sulu/article-bundle
+```
 
-## Installation
+Afterwards, visit the [bundle documentation](https://github.com/sulu/SuluArticleBundle/blob/master/Resources/doc) to 
+find out **how to set up and configure the SuluArticleBundle** to your specific needs.
 
-All the installation instructions are located in the 
-[Documentation](https://github.com/sulu/SuluArticleBundle/blob/master/Resources/doc/installation.md).
 
-## License
+## 💡&nbsp; Key Concepts
 
-This bundle is under the MIT license. See the complete license [in the bundle](LICENSE)
+### Article Characteristics
 
-## Reporting an issue or a feature request
+Like Sulu pages, articles are **configured via templates** and can include additional **SEO and excerpt information**.
+Moreover, articles support the same **drafting, publishing and versioning functionality** as provided by pages.
+In contrast to Sulu pages, articles are **managed in a flat list** instead of a tree structure. Furthermore, unlike 
+the Sulu page tree, the article bundle is **optimized for managing a big number of articles**.
 
-Issues and feature requests are tracked in the [Github issue tracker](https://github.com/Sulu/SuluArticleBundle/issues).
 
-When reporting a bug, it may be a good idea to reproduce it in a basic project built using the
-[Sulu Minimal Edition](https://github.com/sulu/sulu-minimal) to allow developers of the bundle to reproduce the issue
-by simply cloning it and following some steps.
+### Elasticsearch dependency
+
+The SuluArticleBundle was originally developed to be used in the publishing industry. To satisfy the initial 
+requirements regarding performance and scalability, a **view layer stored in an Elasticsearch index** was utilized. 
+Because of this, there is **no way to use the bundle without Elasticsearch** at the moment. It is planned to
+remove this hard dependency in the next major version.
+
+If you cannot or do not want to make Elasticsearch a dependency of your project, you can **use Sulu pages for 
+certain use cases** instead of the SuluArticleBundle. However, be aware that the article list provides a better 
+performance and is more comfortable to use with a large number of entities.
+
+
+## ❤️&nbsp; Support and Contributions
+
+The Sulu content management system is a **community-driven open source project** backed by various partner companies. 
+We are committed to a fully transparent development process and **highly appreciate any contributions**. 
+
+In case you have questions, we are happy to welcome you in our official [Slack channel](https://sulu.io/services-and-support).
+If you found a bug or miss a specific feature, feel free to **file a new issue** with a respective title and description 
+on the the [sulu/SuluArticleBundle](https://github.com/sulu/SuluArticleBundle) repository.
+
+
+## 📘&nbsp; License
+
+The Sulu content management system is released under the under terms of the [MIT License](LICENSE).
+

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "sulu/article-bundle",
-    "description": "Sulu bundle for managing articles",
+    "description": "Bundle for managing localized content-rich entities like blog-posts in the Sulu content management system",
     "type": "sulu-bundle",
     "license": "MIT",
     "homepage": "https://github.com/sulu/SuluArticleBundle",