2015-05-26 00:52:35 +02:00
# SilverStripe Blog Module
2016-01-20 20:37:43 +01:00
[![Build Status ](https://travis-ci.org/silverstripe/silverstripe-blog.svg?branch=master )](https://travis-ci.org/silverstripe/silverstripe-blog)
[![Scrutinizer Code Quality ](https://scrutinizer-ci.com/g/silverstripe/silverstripe-blog/badges/quality-score.png?b=master )](https://scrutinizer-ci.com/g/silverstripe/silverstripe-blog/?branch=master)
[![codecov.io ](https://codecov.io/github/silverstripe/silverstripe-blog/coverage.svg?branch=master )](https://codecov.io/github/silverstripe/silverstripe-blog?branch=master)
2016-05-30 07:35:13 +02:00
![helpfulrobot ](https://helpfulrobot.io/silverstripe/blog/badge )
2016-01-20 20:37:43 +01:00
[![Latest Stable Version ](https://poser.pugx.org/silverstripe/blog/version )](https://packagist.org/packages/silverstripe/blog)
[![License ](https://poser.pugx.org/silverstripe/blog/license )](https://packagist.org/packages/silverstripe/blog)
[![Monthly Downloads ](https://poser.pugx.org/silverstripe/blog/d/monthly )](https://packagist.org/packages/silverstripe/blog)
2016-05-21 06:56:53 +02:00
2013-08-11 01:26:17 +02:00
2015-12-07 23:45:09 +01:00
## Documentation
2013-08-11 02:58:25 +02:00
2016-12-20 04:57:05 +01:00
* [User guide ](docs/en/userguide/index.md )
* [Developer documentation ](docs/en/index.md )
2013-08-11 02:33:53 +02:00
2015-05-26 00:52:35 +02:00
## Requirements
```
2016-12-20 04:57:05 +01:00
silverstripe/cms: ^4.0
silverstripe/lumberjack: ^2.0
silverstripe/tagfield: ^2.0
2015-05-26 00:52:35 +02:00
```
### Suggested Modules
```
silverstripe/widgets: *
silverstripe/comments: *
```
## Installation
```
2016-05-24 03:43:04 +02:00
composer require silverstripe/blog
2015-05-26 00:52:35 +02:00
```
2016-12-20 04:57:05 +01:00
## Upgrading
2015-05-26 00:52:35 +02:00
2016-12-20 04:57:05 +01:00
### Upgrading from 2.x to 3.x
Aside from the framework and CMS upgrades required the blog module should not require anything extra to be completed.
2015-05-26 00:52:35 +02:00
2016-12-20 04:57:05 +01:00
### Upgrading legacy blog to 2.x
2015-05-26 00:52:35 +02:00
2016-12-20 04:57:05 +01:00
If you're upgrading from blog version 1.0 to 2.x you will need to run the `BlogMigrationTask` . Run the task using `dev/tasks/BlogMigrationTask` either via the browser or sake CLI to migrate your legacy blog to the new version data structure.