Skip to content

Commit 7797938

Browse files
statnmapstatnmap
committed
Readme: install from CRAN
1 parent d98a067 commit 7797938

File tree

4 files changed

+40
-25
lines changed

4 files changed

+40
-25
lines changed

‎DESCRIPTION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: gitdown
22
Title: Turn Your Git Commit Messages into a HTML Book
3-
Version: 0.1.1
3+
Version: 0.1.1.9000
44
Authors@R:
55
c(person(given = "Sébastien",
66
family = "Rochette",

‎NEWS.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# gitdown (development version)
2+
13
# gitdown 0.1.1
24

35
* Improve documentation

‎README.Rmd‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ file.copy(list.files("reference/figures", full.names = TRUE),
2424
# gitdown <img src="man/figures/logo.png" align="right" alt="" width="120" />
2525

2626
<!-- badges: start -->
27-
[![Coverage status](https://codecov.io/gh/ThinkR-open/gitdown/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=master)
2827
[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
28+
[![Coverage status](https://codecov.io/gh/ThinkR-open/gitdown/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=master)
2929
[![CRAN status](https://www.r-pkg.org/badges/version/gitdown)](https://CRAN.R-project.org/package=gitdown)
3030
<!-- badges: end -->
3131

@@ -35,6 +35,13 @@ Full documentation on {pkgdown} site : https://thinkr-open.github.io/gitdown/ind
3535

3636
## Installation
3737

38+
You can install the stable version of {gitdown} from CRAN:
39+
40+
```r
41+
install.packages("gitdown")
42+
```
43+
44+
3845
You can install the last version of {gitdown} from GitHub:
3946

4047
``` r

‎README.md‎

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
<!-- badges: start -->
77

8+
[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
89
[![Coverage
910
status](https://codecov.io/gh/ThinkR-open/gitdown/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=master)
10-
[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
1111
[![CRAN
1212
status](https://www.r-pkg.org/badges/version/gitdown)](https://CRAN.R-project.org/package=gitdown)
1313
<!-- badges: end -->
@@ -23,6 +23,12 @@ Full documentation on {pkgdown} site :
2323

2424
## Installation
2525

26+
You can install the stable version of {gitdown} from CRAN:
27+
28+
``` r
29+
install.packages("gitdown")
30+
```
31+
2632
You can install the last version of {gitdown} from GitHub:
2733

2834
``` r
@@ -105,13 +111,13 @@ get_commits_pattern(repo, pattern = "#[[:digit:]]+", ref = "master") %>%
105111
#> # A tibble: 7 x 12
106112
#> pattern.content sha summary message author email when order
107113
#> <chr> <chr> <chr> <chr> <chr> <chr> <dttm> <int>
108-
#> 1 #32 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
109-
#> 2 #1 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
110-
#> 3 #12 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
111-
#> 4 #2 d4af8… Third … "Third … Alice alic… 2021-05-10 13:56:40 3
112-
#> 5 #145 d4af8… Third … "Third … Alice alic… 2021-05-10 13:56:40 3
113-
#> 6 #1 ebad8… exampl… "exampl… Alice alic… 2021-05-10 13:56:40 2
114-
#> 7 <NA> 11c2e… First … "First … Alice alic… 2021-05-10 13:56:40 1
114+
#> 1 #32 86ec5… Add NE… "Add NE… Alice alic… 2021-05-10 14:03:56 4
115+
#> 2 #1 86ec5… Add NE… "Add NE… Alice alic… 2021-05-10 14:03:56 4
116+
#> 3 #12 86ec5… Add NE… "Add NE… Alice alic… 2021-05-10 14:03:56 4
117+
#> 4 #2 5e338… Third … "Third … Alice alic… 2021-05-10 14:03:56 3
118+
#> 5 #145 5e338… Third … "Third … Alice alic… 2021-05-10 14:03:56 3
119+
#> 6 #1 cefcf… exampl… "exampl… Alice alic… 2021-05-10 14:03:56 2
120+
#> 7 <NA> f50e2… First … "First … Alice alic… 2021-05-10 14:03:56 1
115121
#> # … with 4 more variables: tag.name <chr>, tag.message <chr>,
116122
#> # pattern.type <chr>, pattern.title <chr>
117123
```
@@ -130,18 +136,18 @@ get_commits_pattern(
130136
#> # A tibble: 12 x 12
131137
#> pattern.type pattern.content sha summary message author email
132138
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
133-
#> 1 Tickets ticket6789 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
134-
#> 2 Tickets ticket1234 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
135-
#> 3 Issues #32 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
136-
#> 4 Issues #1 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
137-
#> 5 Issues #12 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
138-
#> 6 Tickets <NA> d4af8c93… Third co… "Third commit… Alice alice…
139-
#> 7 Issues #2 d4af8c93… Third co… "Third commit… Alice alice…
140-
#> 8 Issues #145 d4af8c93… Third co… "Third commit… Alice alice…
141-
#> 9 Tickets ticket1234 ebad8089… example:… "example: mod… Alice alice…
142-
#> 10 Issues #1 ebad8089… example:… "example: mod… Alice alice…
143-
#> 11 Tickets <NA> 11c2e4a6… First co… "First commit… Alice alice…
144-
#> 12 Issues <NA> 11c2e4a6… First co… "First commit… Alice alice…
139+
#> 1 Tickets ticket6789 86ec55cd… Add NEWS "Add NEWS\n\n… Alice alice…
140+
#> 2 Tickets ticket1234 86ec55cd… Add NEWS "Add NEWS\n\n… Alice alice…
141+
#> 3 Issues #32 86ec55cd… Add NEWS "Add NEWS\n\n… Alice alice…
142+
#> 4 Issues #1 86ec55cd… Add NEWS "Add NEWS\n\n… Alice alice…
143+
#> 5 Issues #12 86ec55cd… Add NEWS "Add NEWS\n\n… Alice alice…
144+
#> 6 Tickets <NA> 5e338c4c… Third co… "Third commit… Alice alice…
145+
#> 7 Issues #2 5e338c4c… Third co… "Third commit… Alice alice…
146+
#> 8 Issues #145 5e338c4c… Third co… "Third commit… Alice alice…
147+
#> 9 Tickets ticket1234 cefcfbb7… example:… "example: mod… Alice alice…
148+
#> 10 Issues #1 cefcfbb7… example:… "example: mod… Alice alice…
149+
#> 11 Tickets <NA> f50e27f9… First co… "First commit… Alice alice…
150+
#> 12 Issues <NA> f50e27f9… First co… "First commit… Alice alice…
145151
#> # … with 5 more variables: when <dttm>, order <int>, tag.name <chr>,
146152
#> # tag.message <chr>, pattern.title <chr>
147153
```
@@ -160,9 +166,9 @@ With this example, the vignette will show this content:
160166

161167
| File | Tracked in git | Date of creation | Last modification |
162168
|:-------------|:---------------|:--------------------|:--------------------|
163-
| NEWS.md | Yes | 2021-05-10 15:56:41 | 2021-05-10 15:56:41 |
164-
| example.txt | Yes | 2021-05-10 15:56:41 | 2021-05-10 15:56:41 |
165-
| R/my\_mean.R | No | NA | 2021-05-10 15:56:41 |
169+
| NEWS.md | Yes | 2021-05-10 16:03:56 | 2021-05-10 16:03:56 |
170+
| example.txt | Yes | 2021-05-10 16:03:56 | 2021-05-10 16:03:56 |
171+
| R/my\_mean.R | No | NA | 2021-05-10 16:03:56 |
166172

167173
## Sponsor
168174

0 commit comments

Comments
 (0)