Skip to content

Commit

Permalink
Beautify readme (#453)
Browse files Browse the repository at this point in the history
* Correct build status, add twitter

* Add features

* Add images

* Remove colons

* Add documentation link

* Minor changes
  • Loading branch information
chrfritsch committed Nov 24, 2017
1 parent 9db84d6 commit e668070
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 82 deletions.
113 changes: 31 additions & 82 deletions README.md
@@ -1,97 +1,46 @@
# Thunder
# <img src="./files/images/thunder.svg?sanitize=true" alt="Thunder" width="4%"/> Thunder [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=I%20just%20tried%20ThunderCMS.%20The%20CMS%20for%20professional%20publishing!&url=https://www.thunder.org&via=ThunderCoreTeam&hashtags=drupal8,publishing,ThunderCMS)

[![Build Status](https://travis-ci.org/BurdaMagazinOrg/thunder-distribution.svg?branch=8.x-1.x)](https://travis-ci.org/BurdaMagazinOrg/thunder-distribution)
[![Build Status](https://travis-ci.org/BurdaMagazinOrg/thunder-distribution.svg?branch=develop)](https://travis-ci.org/BurdaMagazinOrg/thunder-distribution)

Thunder is a Drupal 8 distribution for professional publishers. It consists of the current Drupal 8 functionality, lots of useful modules from publishers and industry partners, and an environment which makes it easy to install, deploy and add new functionality.

## What's installed by default?

* Admin Toolbar
* Better Normalizers
* Blazy
* Crop
* Ctools
* Dropzonejs
* Empty Fields
* Entity API
* Entity Browser
* Field Group
* Focal Point
* Inline Entity Form
* Libraries API
* Linkit - Enriched linking experience
* Metatag
* Media Entiy
* Media entity image
* Media entity slideshow
* Media entity Instagram
* Media entity twitter
* Media expire
* Paragraphs
* Pathauto
* Scheduler
* Shariff
* Simple XML sitemap
* Slick
* Slick media
* Token
* Video Embed Field

Plus some base configuration:

* A channel taxonomy
* An article content type with some base fields
* Image, gallery, social media and video media types
* Pre configured role for editorial staff
* A set of commonly used paragraph types
* Gallery
* Instagram
* Image
* Video
* Twitter
* Text
* Quote

[Here](https://github.com/BurdaMagazinOrg/thunder-distribution/blob/develop/modules/thunder_paragraphs/README.md) you can find more information about these paragraphs.

## What can be activated optionally?

* Google AdSense integration
* Google Analytics
* Riddle Marketplace
* IVW
* Nexx Video Player
* Facebook Instant Articles
* Valiton Harbourmaster SSO
* Thunder demo content


[Here](https://burdamagazinorg.gitbooks.io/thunder/content/) you can find more information about these modules.
Thunder is a Drupal 8 distribution for professional publishers. It consists of the current Drupal 8 functionality, lots of useful modules from publishers and industry partners, and an environment which makes it easy to install, deploy and add new functionality.

## Feature Highlights
### <img src="./files/images/story_fireplace_b.png" alt="Storytelling" width="2%"/> Storytelling
Create thrilling articles with multimedia content. It’s easy to enrich your article with pictures, video, and social media snippets and arrange everything as you like it.

![Storytelling](./files/images/storytelling.png)
### <img src="./files/images/media_handling_b_0.png" alt="Storytelling" width="2%"/> Media handling
Add pictures, galleries and videos to your article by just dragging and dropping everything right where you need it.
### <img src="./files/images/mobile_friendly_e_0.png" alt="Storytelling" width="2%"/> Mobile friendly
With Thunder, editors and administrators can work from any device – on the go, easy and fast. Users benefit from a modern and flexible front end.

![Mobile preview](./files/images/mobile.png)
### <img src="./files/images/schedule_content_g_0.png" alt="Storytelling" width="2%"/> Schedule content
Plan at which day and time articles should be published – and when they shouldn’t be visible to the public anymore.
### <img src="./files/images/flexible_system_b_0.png" alt="Storytelling" width="2%"/> Flexible system
Benefit from a wide range of additional functionality by industry partners or by one of more than 2,500 modules from the Drupal community.
### <img src="./files/images/drupal_community_b_1.png" alt="Storytelling" width="2%"/> Open Source
Using open source technology reduces development costs and resources and makes you part of the Drupal community with more than 100,000 users actively contributing.

*[More information about the modules used in Thunder](https://burdamagazinorg.github.io/thunder-documentation/modules)*
## Installation

Download thunder from the [distribution page](https://www.drupal.org/project/thunder) or just do:

```
drush dl thunder
```

If you want to install Thunder with composer (recommended) do the following:
**Highly recommended: Install Thunder with composer**

```
composer create-project burdamagazinorg/thunder-project thunder --no-interaction
```
For further information follow the [install instructions](https://www.drupal.org/docs/8/install).

For further information follow the [install instructions](https://www.drupal.org/docs/8/install).

## Configuration
If you don't want to use Composer, you can install Thunder the traditional way by downloading a tarball from our [drupal.org](https://www.drupal.org/project/thunder) project page.
## Issues & Contribution
If you found an issue with Thunder, please open a [ticket](https://www.drupal.org/project/issues/thunder?categories=All) on drupal.org. Please have in mind that Thunder is a collection of many drupal contrib modules. So, if you can track down an issue to a specific module, please open the ticket in the corresponding issue queue.

In Thunder's default configuration, the automated cron module is disabled. For correct functioning of non-local sites, crons should be configured properly.
There are two types of crons which should be configured:
If you want to help, to make Thunder even better, open an [issue](https://www.drupal.org/project/issues/thunder?categories=All) on drupal.org or just create a pull request.

* [Configure cron](https://www.drupal.org/docs/7/setting-up-cron-for-drupal/configuring-cron-jobs-using-the-cron-command)
* [Configure the schedulers cron](http://cgit.drupalcode.org/scheduler/tree/README.txt?h=8.x-1.x) (Used for automated article publishing)
## Documentation
For more detailed information, please take a look at [https://burdamagazinorg.github.io/thunder-documentation/](https://burdamagazinorg.github.io/thunder-documentation/).

## Development

For Development information please take a look at [docs/development.md](docs/development.md).
For information on the installation and development of Thunder, please take a look at [docs/development.md](docs/development.md).
Binary file added files/images/drupal_community_b_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/flexible_system_b_0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/media_handling_b_0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/mobile.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/mobile_friendly_e_0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/schedule_content_g_0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/story_fireplace_b.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added files/images/storytelling.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e668070

Please sign in to comment.