Skip to content

Commit

Permalink
[DOCS] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ErHaWeb committed Oct 10, 2023
1 parent 7c0ddea commit 2eb8a05
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Feed Display

## What does it do?

The aim of this extension is to provide a way to display RSS and Atom web
feed data retrieved from any URL in the frontend. It is possible to configure
which data is to be read from the feed for the purpose of display.
Expand All @@ -12,4 +14,62 @@ so that the feed does not have to be parsed with each call. If something has
changed in the plugin configuration (TypoScript or FlexForm), the cache is
renewed immediately, otherwise only after a configurable time has elapsed.

For more information, see the documentation at [docs.typo3.org](https://docs.typo3.org/p/erhaweb/feed-display/1.2/en-us/).
## Screenshots

Here you can find screenshots of all application areas of this extension.

### Frontend View

Below you can find an example of the frontend output of the official TYPO3
news feed. Styling and structure can be customized as you like.

![Frontend View](Documentation/Images/FrontendView.png)

### New Content Element Wizard

![New Content Element Wizard](Documentation/Images/NewContentElementWizard.png)

### Plugin Settings

Below you can find screenshots of all available plugin options. Use these
options if you want to make settings on content element level.
Alternatively, these can also be configured by TypoScript Constants in the
constant editor.

#### General

![Plugin Options: General Tab](Documentation/Images/PluginOptions-General.png)

#### Advanced

![Plugin Options: Advanced Tab](Documentation/Images/PluginOptions-Advanced.png)

#### Get Fields

![Plugin Options: Get Fields Tab](Documentation/Images/PluginOptions-GetFields.png)

### Constant Editor

Below you can find screenshots of all available constants in the constant
editor. Use these options if you want to make settings on a global level for
all content elements.

#### Files

![Plugin Options: General Tab](Documentation/Images/ConstantEditor-Files.png)

#### General

![Plugin Options: General Tab](Documentation/Images/ConstantEditor-General.png)

#### Advanced

![Plugin Options: General Tab](Documentation/Images/ConstantEditor-Advanced.png)

#### Get Fields

![Plugin Options: General Tab](Documentation/Images/ConstantEditor-GetFields.png)

## Read more

For more information, see the documentation at [docs.typo3.org](https://docs.typo3.org/p/erhaweb/feed-display/main/en-us/).

0 comments on commit 2eb8a05

Please sign in to comment.