Skip to content

Commit

Permalink
doc: add new feat in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahasverus committed Mar 30, 2024
1 parent 966f350 commit 54fbf11
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
11 changes: 8 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,27 @@ calendar <img src="man/figures/logo.png" align="right" style="float:right; heigh
The R package `calendar` is dedicated to create a monthly calendar. It plots and exports the calendar as a `pdf` file (ready to print in the A4 paper format). Holidays (only France is supported yet) are identified and user can easily add events (up to four by day). User can also choose between of a week of five days (working week) or a full week (weekend included).


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

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

<br/>

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

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

<br/>

- Monthly calendar with events
- **Monthly calendar with events**

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

<br/>

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

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


## Installation
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,28 @@ and user can easily add events (up to four by day). User can also choose
between of a week of five days (working week) or a full week (weekend
included).

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

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

<br/>

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

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

<br/>

- Monthly calendar with events
- **Monthly calendar with events**

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

<br/>

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

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

## Installation

You can install the development version from
Expand Down
Binary file added 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.

0 comments on commit 54fbf11

Please sign in to comment.