silverstripe-versionfeed/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

2012-11-26 01:22:30 +01:00
# Version Feed
2022-07-05 12:18:11 +02:00
[![CI](https://github.com/silverstripe/silverstripe-versionfeed/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-versionfeed/actions/workflows/ci.yml)
2022-07-31 23:54:09 +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/)
2013-10-29 12:06:34 +01:00
2012-11-26 01:22:30 +01:00
## Overview
The module creates an RSS feed on each page with their change history, as well as one for the entire site.
## Requirements
2022-07-31 23:54:09 +02:00
* Silverstripe ^4
2012-11-26 01:22:30 +01:00
2022-07-31 23:54:09 +02:00
**Note:** For a Silverstripe 3.x compatible version, please use [the 1.x release line](https://github.com/silverstripe/silverstripe-versionfeed/tree/1.2).
2012-11-26 01:22:30 +01:00
2017-12-11 23:39:57 +01:00
## Installation
2012-11-26 01:22:30 +01:00
2022-07-31 23:54:09 +02:00
Install with composer by running `composer require silverstripe/versionfeed` in the root of your Silverstripe project.
2012-11-26 01:22:30 +01:00
## Usage
For usage instructions see [user manual](docs/en/userguide/index.md).
2013-10-24 23:33:20 +02:00
## Translations
2013-10-24 23:33:20 +02:00
Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.
2017-05-12 00:23:51 +02:00
Please use [https://www.transifex.com/projects/p/silverstripe-versionfeed](https://www.transifex.com/projects/p/silverstripe-versionfeed) to contribute translations, rather than sending pull requests with YAML files.