From f7c1debbd5a83b69ac9a3c6f25f5c35337d05222 Mon Sep 17 00:00:00 2001 From: zoreet Date: Thu, 18 Jan 2024 02:02:37 +0100 Subject: [PATCH] chore: update readme to talk about the new daysToShow parameter --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e3fd912..ebfde2d 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,27 @@ Make sure to specify the path you're using. You can point to one habit, or all h ## Parameters -- path [mandatory]: a string containing a path to a folder or specific habit (aka .md file) -- lastDisplayedDate [optional]: the date that is displayed in the chart +- **path** _[mandatory]_: a string containing a path to a folder or specific habit (aka .md file) + +- **lastDisplayedDate** _[optional]_: the date that is displayed in the chart + - format: `"YYYY-MM-DD"` - - default to today + - defaults to today - example settings `{ "path": "Habits/", "lastDisplayedDate": "2023-12-27" }` +- **daysToShow** _[optional]_: how many dates to display in the chart + + - default: `21` + + `{ + "path": "Habits/", + "daysToShow": "31" +}` + ## Example ![Example](docs/assets/ui-demo.png)