Skip to content

Commit

Permalink
chore: update readme to talk about the new daysToShow parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
zoreet committed Jan 18, 2024
1 parent 21ada5e commit f7c1deb
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit f7c1deb

Please sign in to comment.