From b19d837e5f3fcdf8740e170cf200910c78c778f1 Mon Sep 17 00:00:00 2001
From: Alex Debril <alex.debril@gmail.com>
Date: Fri, 9 Aug 2019 15:00:21 +0200
Subject: [PATCH] Documentation

---
 README.md                     | 10 +++++-----
 Resources/sample/Provider.php |  7 ++++---
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 3706022..ccda36c 100644
--- a/README.md
+++ b/README.md
@@ -189,12 +189,12 @@ The request will be handled by `StreamController`, according to the following st
 
 You must give to RssAtomBundle the content you want it to display in the feed. For that, two steps :
 
-- write a class that implements `FeedContentProviderInterface`. This class that we call a 'provider' will be in charge of building the feed.
+- write a class that implements `FeedProviderInterface`. This class that we call a 'provider' will be in charge of building the feed.
 - configure the dependency injection to make RssAtomBundle use it
 
 ##### FeedContentProviderInterface implementation
 
-Your class just needs to implement the `Debril\RssAtomBundle\Provider\FeedContentProviderInterface` interface, for instance :
+Your class just needs to implement the `Debril\RssAtomBundle\Provider\FeedProviderInterface` interface, for instance :
 
 ```php
 <?php
@@ -206,14 +206,14 @@ use FeedIo\FeedInterface;
 use FeedIo\Feed\Item;
 use Debril\RssAtomBundle\Provider\FeedContentProviderInterface;
 
-class Provider implements FeedContentProviderInterface
+class Provider implements FeedProviderInterface
 {
     /**
      * @param array $options
      * @return \FeedIo\FeedInterface
      * @throws \Debril\RssAtomBundle\Exception\FeedNotFoundException
      */
-    public function getFeedContent(array $options) : FeedInterface
+    public function getFeed(Request $request) : FeedInterface
     {
         // build the feed the way you want
         $feed = new Feed();
@@ -241,7 +241,7 @@ class Provider implements FeedContentProviderInterface
 }
 ```
 
-StreamController expects the getFeedContent()'s return value to be a `FeedIo\FeedInterface` instance. It can be a `FeedIo\Feed` or a class of your own and if so, your class MUST implement `\FeedIo\FeedInterface`.
+StreamController expects the getFeed()'s return value to be a `FeedIo\FeedInterface` instance. It can be a `FeedIo\Feed` or a class of your own and if so, your class MUST implement `\FeedIo\FeedInterface`.
 
 You can also start from this class to save some time : [App\Feed\Provider.php](/Resources/sample/Provider.php)
 
diff --git a/Resources/sample/Provider.php b/Resources/sample/Provider.php
index 751032b..dee552d 100644
--- a/Resources/sample/Provider.php
+++ b/Resources/sample/Provider.php
@@ -9,15 +9,16 @@
 use App\Repository\PostRepository;
 
 // All you really need to create a feed
-use Debril\RssAtomBundle\Provider\FeedContentProviderInterface;
+use Debril\RssAtomBundle\Provider\FeedProviderInterface;
 use Doctrine\Bundle\DoctrineBundle\Registry;
 use FeedIo\Feed;
 use FeedIo\Feed\Node\Category;
 use FeedIo\FeedInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Router;
 
-class Provider implements FeedContentProviderInterface
+class Provider implements FeedProviderInterface
 {
 
     protected $logger;
@@ -43,7 +44,7 @@ public function __construct(LoggerInterface $logger, Registry $registry, Router
      * @param array $options
      * @return FeedInterface
      */
-    public function getFeedContent(array $options) : FeedInterface
+    public function getFeed(Request $request) : FeedInterface
     {
         $feed = new Feed();
         $feed->setTitle('Feed Title')