From 53b16491565f02c0d0f6a0f406d92ef22620a4f5 Mon Sep 17 00:00:00 2001
From: chocolateboy <chocolate@cpan.org>
Date: Thu, 3 May 2018 22:45:44 +0100
Subject: [PATCH] update the README to reflect the required Rake-task options

PR #451 removes the repo-guessing code, which both:

* allows the user and project to be set in the Rake task
* *requires* the user and project to be set in the Rake task

update the Rake example in the README to reflect this new usage
---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index ec2ddae2e..6cc9d9b1e 100644
--- a/README.md
+++ b/README.md
@@ -164,6 +164,8 @@ Configure the task in your `Rakefile`:
 require 'github_changelog_generator/task'
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'username'
+  config.project = 'project-name'
   config.since_tag = '0.1.14'
   config.future_release = '0.2.0'
 end