silverstripe-blog/README.md

# SilverStripe Blog Module
[![Build Status](https://api.travis-ci.com/silverstripe/silverstripe-blog.svg?branch=3)](https://travis-ci.com/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)
[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

## Documentation

* [User guide](docs/en/userguide/index.md)
* [Developer documentation](docs/en/index.md)

## Requirements

* SilverStripe CMS 4.0+
* SilverStripe Lumberjack Module 2.0+
* SilverStripe Tag Field Module 2.0+
* SilverStripe Assets 1.0+
* SilverStripe Asset Admin Module 1.0+

Note: this version is compatible with SilverStripe 4. For SilverStripe 3, please see [the 2.x release line](https://github.com/silverstripe/silverstripe-blog/tree/2).

### Suggested Modules

* SilverStripe Widgets Module
* SilverStripe Comments Module

## Installation

```
composer require silverstripe/blog
```

## Upgrading

### 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.

### Upgrading legacy blog to 2.x

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.
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00			`# SilverStripe Blog Module`
Update build status badge 2021-01-21 16:28:42 +13:00			`[![Build Status](https://api.travis-ci.com/silverstripe/silverstripe-blog.svg?branch=3)](https://travis-ci.com/silverstripe/silverstripe-blog)`
ENHANCEMENT: Added code coverage and extra badges on the home page 2016-01-21 02:37:43 +07:00			`[![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)`
Add supported module badge to readme 2018-06-15 17:31:09 +12:00			`[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)`
Updated README 2013-08-11 00:26:17 +01:00
DOCS Rework documentation to have clear user guide and dev docs. 2015-12-08 11:45:09 +13:00			`## Documentation`
corrected readme 2013-08-11 01:58:25 +01:00
Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 16:57:05 +13:00			`* [User guide](docs/en/userguide/index.md)`
			`* [Developer documentation](docs/en/index.md)`
Updated composer and renamed from silverstripe-blog to silverstripe-blogger to avoid confusion 2013-08-11 01:33:53 +01:00
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00			`## Requirements`

Update readme, editorconfig, phpcs ruleset 2018-01-29 16:01:08 +13:00			`* SilverStripe CMS 4.0+`
			`* SilverStripe Lumberjack Module 2.0+`
			`* SilverStripe Tag Field Module 2.0+`
			`* SilverStripe Assets 1.0+`
			`* SilverStripe Asset Admin Module 1.0+`

			`Note: this version is compatible with SilverStripe 4. For SilverStripe 3, please see [the 2.x release line](https://github.com/silverstripe/silverstripe-blog/tree/2).`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00
			`### Suggested Modules`

Update readme, editorconfig, phpcs ruleset 2018-01-29 16:01:08 +13:00			`* SilverStripe Widgets Module`
			`* SilverStripe Comments Module`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00
			`## Installation`

			```
DOCS updated installation instructions Fixes #398 2016-05-24 13:43:04 +12:00			`composer require silverstripe/blog`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00			```

Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 16:57:05 +13:00			`## Upgrading`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00
Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 16:57:05 +13: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.`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00
Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 16:57:05 +13:00			`### Upgrading legacy blog to 2.x`
improve docs - Document new features - Document upgrading 2015-05-26 10:52:35 +12:00
Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 16:57:05 +13: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.