Add more written documentation for pkgdown site

ellisvalentiner · Sep 25, 2017 · b0cb75f · b0cb75f
1 parent 5afb8b7
commit b0cb75f
Show file tree

Hide file tree

Showing 25 changed files with 449 additions and 39 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,6 @@
+
+# lubridateExtras 0.1.0
+
+## 2017-09-24
+
+* Initial release notes
diff --git a/R/instants.R b/R/instants.R
@@ -104,7 +104,7 @@ next_month <- function(tzone = "") {
 #' is.weekend("2017-08-29")  # FALSE
 #' is.weekend("2017-09-02")  # TRUE
 is.weekend <- function(x) {
-  wday(x = as_date(x), label = FALSE, abbr = FALSE) %in% 6:7
+  wday(x = as_date(x), label = FALSE, abbr = FALSE) %in% c(1, 7)
 }
 
 #' Is x a weekday?
@@ -118,5 +118,5 @@ is.weekend <- function(x) {
 #' is.weekend("2017-08-29")  # FALSE
 #' is.weekend("2017-09-02")  # TRUE
 is.weekday <- function(x) {
-  wday(x = as_date(x), label = FALSE, abbr = FALSE) %in% 1:5
+  wday(x = as_date(x), label = FALSE, abbr = FALSE) %in% 2:6
 }
diff --git a/README.Rmd b/README.Rmd
@@ -41,9 +41,17 @@ If you encounter a clear bug, please file a minimal reproducible example on [git
 ```{r}
 library(lubridateExtras)
 
+yesterday()
+
+tomorrow()
+
 days_ago(7)  # equivalent to lubridate::today() - lubridate::days(7)
 
 days_hence(7)  # equivalent to lubridate::today() + lubridate::days(7)
 ```
 
+## Why lubridateExtras?
+
+Some people are probably asking the question: why lubridateExtras?
 
+lubridateExtras does not do anything that you cannot do with lubridate but similarly you don't need lubridate at all to work with date/times in R! If you like the syntactic sugar of lubridateExtras then use it, otherwise stick with what works for you.
diff --git a/README.md b/README.md
@@ -29,9 +29,22 @@ Usage
 ``` r
 library(lubridateExtras)
 
+yesterday()
+#> [1] "2017-09-23"
+
+tomorrow()
+#> [1] "2017-09-25"
+
 days_ago(7)  # equivalent to lubridate::today() - lubridate::days(7)
-#> [1] "2017-09-14"
+#> [1] "2017-09-17"
 
 days_hence(7)  # equivalent to lubridate::today() + lubridate::days(7)
-#> [1] "2017-09-28"
+#> [1] "2017-10-01"
 ```
+
+Why lubridateExtras?
+--------------------
+
+Some people are probably asking the question: why lubridateExtras?
+
+lubridateExtras does not do anything that you cannot do with lubridate but similarly you don't need lubridate at all to work with date/times in R! If you like the syntactic sugar of lubridateExtras then use it, otherwise stick with what works for you.
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -11,7 +11,7 @@ navbar:
   type: default
   left:
   - text: Intro
-    href: lubridateExtras.html
+    href: articles/intro.html
   - text: Reference
     href: reference/index.html
   - text: News

diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/intro.html b/docs/articles/intro.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html