Skip to content

Commit

Permalink
doc: improve description in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Mar 30, 2024
1 parent c661118 commit aebe501
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 8 deletions.
20 changes: 16 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -44,26 +44,38 @@ The R package `calendar` is dedicated to create a monthly calendar. It plots and

- **Empty monthly calendar (with weekends)**

![](man/figures/calendar-demo-2.png)
![](man/figures/calendar-demo-1.png)

<br/>

- **Empty monthly calendar (without weekend)**

![](man/figures/calendar-demo-1.png)
![](man/figures/calendar-demo-2.png)

<br/>

- **Monthly calendar with events**
- **Monthly calendar with single-day events**

![](man/figures/calendar-demo-3.png)

<br/>

- **Monthly calendar with multi-weeks events**
- **Monthly calendar with multi-day events**

![](man/figures/calendar-demo-4.png)

<br/>

- **Monthly calendar with multi-week events**

![](man/figures/calendar-demo-5.png)

<br/>

- **All-in-one**

![](man/figures/calendar-demo-6.png)


## Installation

Expand Down
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,38 @@ included).

- **Empty monthly calendar (with weekends)**

![](man/figures/calendar-demo-2.png)
![](man/figures/calendar-demo-1.png)

<br/>

- **Empty monthly calendar (without weekend)**

![](man/figures/calendar-demo-1.png)
![](man/figures/calendar-demo-2.png)

<br/>

- **Monthly calendar with events**
- **Monthly calendar with single-day events**

![](man/figures/calendar-demo-3.png)

<br/>

- **Monthly calendar with multi-weeks events**
- **Monthly calendar with multi-day events**

![](man/figures/calendar-demo-4.png)

<br/>

- **Monthly calendar with multi-week events**

![](man/figures/calendar-demo-5.png)

<br/>

- **All-in-one**

![](man/figures/calendar-demo-6.png)

## Installation

You can install the development version from
Expand Down
Binary file modified man/figures/calendar-demo-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/calendar-demo-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/calendar-demo-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/calendar-demo-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/figures/calendar-demo-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/figures/calendar-demo-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aebe501

Please sign in to comment.