mirror of
https://github.com/silverstripe/silverstripe-comments
synced 2024-10-22 11:05:49 +02:00
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
# Comments
|
|
|
|
[![Build Status](https://api.travis-ci.com/silverstripe/silverstripe-comments.svg?branch=3)](https://travis-ci.com/silverstripe/silverstripe-comments)
|
|
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/silverstripe/silverstripe-comments.svg)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-comments/?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/)
|
|
[![Code Coverage](https://img.shields.io/codecov/c/github/silverstripe/silverstripe-comments.svg)](https://codecov.io/gh/silverstripe/silverstripe-comments)
|
|
|
|
## Introduction
|
|
|
|
This module provides commenting functionality for Pages and other DataObjects on your SilverStripe site.
|
|
|
|
For more documentation about the module see the provided documentation located inside the docs folder.
|
|
|
|
## Requirements
|
|
|
|
* SilverStripe ^4.0
|
|
|
|
**Note:** This branch is compatible with SilverStripe 4. For a SilverStripe 3 release, please see the 2.x release line.
|
|
|
|
## Installation
|
|
|
|
```
|
|
composer require silverstripe/comments
|
|
```
|
|
|
|
See docs/en/Installing.md
|
|
|
|
## Related
|
|
|
|
* [silverstripe/silverstripe-comments-notifications](https://github.com/silverstripe/silverstripe-comments-notifications): Comment admin email notifications module
|
|
|
|
## Contributing
|
|
|
|
### Translations
|
|
|
|
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.
|
|
|
|
Please use https://www.transifex.com/projects/p/silverstripe-comments/ to contribute translations,
|
|
rather than sending pull requests with YAML files.
|
|
|
|
See the ["i18n" topic](https://docs.silverstripe.org/en/4/developer_guides/i18n/) on doc.silverstripe.org for more details.
|