diff --git a/README.md b/README.md index 6beaa3068e9ac500119067bd60a754561d403e14..076c0434ebfdffd348d9b277c80b8d88b6a40870 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,41 @@ TYPO3 version: >7.6 Integrates a powerful News-System. News and Categories can be created like normal TYPO3 pages. Newspages have several additional meta information. +### Plugins + +This extension comes with several plugins to display and categorize news. + +###### News Overview +Provides an overview over all news. Additionally there is a tab navigation for groups of news. + +Plugin options: + +- **Group By**: By which aspect should your news be grouped in the tab navigation (none, category, tags) +- **News Limit**: The maximum amount news to be displayed. Further news can be displayed after the user clicks a button. +- **Only news within this page section**: Should only news from subpages be shown, or from all sites in this TYPO3 instance ? + +###### List News by Category/Tag + +Lists all news from subpages for the given Categories / Tags. + +Plugin options: + +- **News Limit per Page**: The maximum amount of news to be shown. +- **Categories**: Here you can select which categories you want to be included (If none are selected, all are shown). +- **Tags**: Here you can select which tags the news entries need to have to be shown here (If none are selected, all are shown). + +###### News Single View +Provides a new page type **News**, that renders the content as a news element in the frontend. + +###### News Feed +@todo + +###### PageBrowser +@todo + +###### addLike +Adds an AJAX like button to each single news entry. + ## Integration Before using sg_news you need to supply your frontend some information on how the extension needs to be integrated into your template.