From 1ff2e5c22880b6bdaa9e1c45eba9aef281d8c3cb Mon Sep 17 00:00:00 2001
From: George Tsagkarelis <george.tsagkarelis@gmail.com>
Date: Wed, 15 Feb 2023 19:37:02 +0200
Subject: [PATCH] docs: add recurring budget and release note

---
 docs/autoloop.md | 23 ++++++++++-------------
 release_notes.md |  3 +++
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/autoloop.md b/docs/autoloop.md
index 3c85357..0c40d37 100644
--- a/docs/autoloop.md
+++ b/docs/autoloop.md
@@ -157,7 +157,7 @@ The autolooper operates within a set budget, and will stop executing swaps when
 this budget is reached. This budget includes the fees paid to the swap server, 
 on-chain sweep costs and off-chain routing fees. Note that the budget does not 
 include the actual swap amount, as this balance is simply shifted from off-chain 
-to on-chain, rather than used up. 
+to on-chain, rather than used up.
 
 The budget value is expressed in satoshis, and can be set using the `setparams` 
 loop command:
@@ -165,23 +165,20 @@ loop command:
 loop setparams --autobudget={budget in satoshis}
 ```
 
-Your autoloop budget can optionally be paired with a start time, which 
-determines the time from which we will count autoloop swaps as being part of 
-the budget. If this value is zero, it will consider all automatically 
-dispatched swaps as being part of the budget. 
-
-The start time is expressed as a unix timestamp, and can be set using the 
-`setparams` loop command:
+Your autoloop budget is refreshed based on a configurable interval. You can
+specify how often the budget is going to refresh by using the `setparams` loop
+command:
 ```
-loop setparams --budgetstart={start time in seconds}
+loop setparams --autobudgetrefreshperiod={duration in seconds}
 ```
 
+
 If your autolooper has used up its budget, and you would like to top it up, you 
-can do so by either increasing the overall budget amount, or by increasing the 
-start time to the present. For example, if you want to set your autolooper to 
-have a budget of 100k sats for the month, you could set the following:
+can do so by either increasing the overall budget amount, or by decreasing the 
+refresh interval. For example, if you want to set your autolooper to 
+have a budget of 100k sats per 7 days (or 604800 seconds), you could set the following:
 ```
-loop setparams --autobudget=100000 --autostart={beginning of month ts}
+loop setparams --autobudget=100000 --autobudgetrefreshperiod=604800
 ```
 
 ## Dispatch Control
diff --git a/release_notes.md b/release_notes.md
index c71d135..3c5fd73 100644
--- a/release_notes.md
+++ b/release_notes.md
@@ -15,6 +15,9 @@ This file tracks release notes for the loop client.
 ## Next release
 
 #### New Features
+* Autoloop now uses a recurring budget. Users can now specify `autobudget` and
+`autobudgetrefreshperiod` to specify the amount of the budget and the period
+over which it will refresh.
 
 #### Breaking Changes