silverstripe-blog/README.md

# Silverstripe Blog Module

[![CI](https://github.com/silverstripe/silverstripe-blog/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-blog/actions/workflows/ci.yml)
[![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.
MNT Standardise modules 2022-08-01 00:03:47 +02:00			`# Silverstripe Blog Module`

MNT Use GitHub Actions CI 2022-07-14 01:28:50 +02:00			`[![CI](https://github.com/silverstripe/silverstripe-blog/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-blog/actions/workflows/ci.yml)`
MNT Standardise modules 2022-08-01 00:03:47 +02: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 01:26:17 +02:00
DOCS Rework documentation to have clear user guide and dev docs. 2015-12-07 23:45:09 +01:00			`## Documentation`
corrected readme 2013-08-11 02:58:25 +02:00
Update Travis and Scrutinizer configuration, add note to readme 2016-12-20 04:57:05 +01: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 02:33:53 +02:00
improve docs - Document new features - Document upgrading 2015-05-26 00:52:35 +02:00			`## Requirements`

MNT Standardise modules 2022-08-01 00:03:47 +02: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+`
Update readme, editorconfig, phpcs ruleset 2018-01-29 04:01:08 +01:00
MNT Standardise modules 2022-08-01 00:03:47 +02:00			`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 00:52:35 +02:00
			`### Suggested Modules`

MNT Standardise modules 2022-08-01 00:03:47 +02:00			`* Silverstripe Widgets Module`
			`* Silverstripe Comments Module`
improve docs - Document new features - Document upgrading 2015-05-26 00:52:35 +02:00
			`## Installation`

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

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