Merge pull request #27 from assertchris/add-community-files

Added community files

.editorconfig

@@ -0,0 +1,24 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+indent_style = space
+
+[{.travis.yml,package.json}]
+# The indent size used in the `package.json` file cannot be changed
+# https://github.com/npm/npm/pull/3180#issuecomment-16336516
+indent_size = 2
+indent_style = space

.gitattributes

@@ -0,0 +1,3 @@
+/tests            export-ignore
+/.gitattributes   export-ignore
+/.travis.yml      export-ignore

changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.0.0]
+
+Changelog added.

code-of-conduct.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+https://docs.silverstripe.org/en/3.1/contributing/code_of_conduct/

contributing.md

@@ -0,0 +1,3 @@
+# Contributing
+
+Contributions are welcome! Create an issue, explaining a bug or proposal. Submit pull requests if you feel brave. Speak to me on [Twitter](https://twitter.com/assertchris).

docs/en/index.md

@@ -24,18 +24,15 @@ There are two types of roles with this module.
  * Content reviewers can be assigned to a page, a page and all sub-pages, or globally.
  * The content review schedule can be automatic, e.g. every month, and/or a specific date.
 
-## Wishlist features:
-
- * Overdue review reminder emails.
- * Customisable reminder emails.
-
 ## Requirements
 
  * SilverStripe Framework and CMS
 
 ## Composer installation
 
-	composer require silverstripe/contentreview
+```sh
+$ composer require silverstripe/contentreview
+```
 
 ## Manual installation
 
@@ -70,12 +67,18 @@ and previous reviews in the same view, but cannot change anything.
 
 ## Testing
 
-cd to the site root, and run 
+cd to the site root, and run:
-	php vendor/bin/behat
 
-or to test this module when used on a website
+```sh
-	php vendor/bin/behat contentreview/tests
+$ php vendor/bin/behat
+```
+
+or to test this module when used on a website:
+
+```sh
+$ php vendor/bin/behat contentreview/tests
+```
 
 ## Migration
 
- * If you are upgrading from an older version, you may need to run the ContentReviewOwnerMigrationTask
+If you are upgrading from an older version, you may need to run the `ContentReviewOwnerMigrationTask`

readme.md

@@ -0,0 +1,55 @@
+# Content Review module
+
+[![Build Status](https://travis-ci.org/silverstripe-labs/silverstripe-contentreview.png?branch=feature_improvements)](https://travis-ci.org/silverstripe-labs/silverstripe-contentreview)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/silverstripe-labs/silverstripe-contentreview/badges/quality-score.png?s=e68f2c583f03c7eab0326781f6219f0ed58c9ad8)](https://scrutinizer-ci.com/g/silverstripe-labs/silverstripe-contentreview/)
+[![Code Coverage](https://scrutinizer-ci.com/g/silverstripe-labs/silverstripe-contentreview/badges/coverage.png?s=42151d66ef5121363face01c03c94dc479baa408)](https://scrutinizer-ci.com/g/silverstripe-labs/silverstripe-contentreview/)
+
+This module helps keep your website content accurate and up-to-date, which keeps your users happy. 
+
+It does so by sending reviewers reminder emails to go in and check the content. For a reviewer this 
+often includes checking links, grammar, factual information and look and feel.
+
+There are two types of roles with this module. 
+
+ * Website owner; (typically assigned to the Administrator group) ensures that a website is accurate and up-to-date, by delegating responsibility to content reviewers.
+ * Content reviewer; responsible for keeping a website or part of a website accurate and up-to-date.
+
+## Requirements
+
+ * SilverStripe ^3.1
+
+## Features
+
+ * Content reviewer will receive an email notification when a page is due for review. 
+ * Content reviewer can mark a page as 'reviewed', and provide review notes.
+ * Website owner can assign content reviewers to a page and set when the content should be reviewed.
+ * Website owner can see a report of pages and their reviewed status.
+ * Content reviewers can be assigned to a page, a page and all sub-pages, or globally.
+ * The content review schedule can be automatic, e.g. every month, and/or a specific date. 
+
+## Wishlist features
+
+ * Overdue review reminder emails.
+ * Customisable reminder emails.
+
+## Composer installation
+
+```sh
+$ composer require silverstripe/contentreview
+```
+
+You'll also need to run `dev/build`.
+
+## Documentation
+
+See the [docs/en](docs/en/introduction.md) folder.
+
+## Versioning
+
+This library follows [Semver](http://semver.org). According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.
+
+All methods, with `public` visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep `protected` methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.
+
+## Reporting Issues
+
+Please [create an issue](https://github.com/silverstripe/silverstripe-contentreview/issues) for any bugs you've found, or features you're missing.