v0.0.1 release

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: typstcv
 Type: Package
 Title: CV for Quarto & Typst
-Version: 0.0.0.9004
+Version: 0.0.1
 Authors@R: 
  person(given = "Kazuharu",
  family = "Yanagimoto",

R/typstcv.R

@@ -19,6 +19,18 @@
 #' )
 #'
 #' resume_entry(educ)
+#' 
+#' # With details
+#' award <- data.frame(
+#' title = c("Nobel Prize in Physics"),
+#' location = c("Stockholm, Sweden"),
+#' date = c("1921"),
+#' description = c("For his services to"),
+#' detail1 = c("Theoretical Physics"),
+#' detail2 = c("Discovery of the law of the photoelectric effect")
+#' )
+#' 
+#' resume_entry(award, details = c("detail1", "detail2"))
 #'
 resume_entry <- function(data,
  title = "title",

README.md

@@ -51,6 +51,8 @@ quarto use template kazuyanagimoto/quarto-awesomecv-typst
 
 ### YAML
 
+![](vignettes/img/awesomecv_header.svg)
+
 Set author information in YAML.
 
 ``` yaml
@@ -93,35 +95,60 @@ format:
 `resume_entry()` is a helper function to create resume entryies from a
 data frame.
 
+``` r
+educ
+#> title location date description
+#> 1 Ph.D. in Physics Zürich, Switzerland 1905 University of Zürich
+#> 2 Master of Science Zürich, Switzerland 1896 - 1900 ETH
+```
+
 ``` r
 educ |>
  resume_entry(
  title = "title",
  location = "location",
- date = "year",
- description = "detail"
+ date = "date",
+ description = "description"
 )
 ```
 
+![](vignettes/img/awesomecv_educ.svg)
+
 You can add bullet points by `details` argument.
 
 ``` r
 resume_entry(award, details = c("detail1", "detail2"))
 # resume_entry(award, details = grep("^detail", names(award)))
 ```
 
+![](vignettes/img/awesomecv_award.svg)
+
 ### Date Formatter
 
 `date_formatter()` is a helper function to format dates in the resume.
 
+``` r
+work
+#> title location start end
+#> 1 Technical Assistant Bern, Switzerland 1902-01-01 1908-01-01
+#> 2 Junior Professor Bern, Switzerland 1908-01-01 1909-01-01
+#> 3 Associate Professor Zürich, Switzerland 1909-01-01 1911-01-01
+#> description
+#> 1 Federal Patent Office
+#> 2 University of Bern
+#> 3 University of Zürich
+```
+
 ``` r
 work |>
  format_date(
- start = "date_start",
- end = "date_end",
+ start = "start",
+ end = "end",
  date_format = "%Y",
  sep = "->",
  sort_by = "start"
  ) |>
  resume_entry()
 ```
+
+![](vignettes/img/awesomecv_work.svg)

README.qmd

@@ -42,6 +42,11 @@ You can find a simple [example](https://kazuyanagimoto.com/typstcv/vignettes/awe
 [qmd](https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/awesomecv/awesomecv.qmd)
 code.
 
+```{r}
+#| include: false
+library(typstcv)
+```
+
 ### Use Template
 
 You can use the template with `quarto` command.
@@ -52,6 +57,8 @@ quarto use template kazuyanagimoto/quarto-awesomecv-typst
 
 ### YAML
 
+![](vignettes/img/awesomecv_header.svg)
+
 Set author information in YAML.
 
 ```yaml
@@ -91,35 +98,49 @@ format:
 
 `resume_entry()` is a helper function to create resume entryies from a data frame.
 
+```{r}
+educ
+```
+
 ```r
 educ |>
  resume_entry(
  title = "title",
  location = "location",
- date = "year",
- description = "detail"
+ date = "date",
+ description = "description"
 )
 ```
 
+![](vignettes/img/awesomecv_educ.svg)
+
 You can add bullet points by `details` argument.
 
 ```r
 resume_entry(award, details = c("detail1", "detail2"))
 # resume_entry(award, details = grep("^detail", names(award)))
 ```
 
+![](vignettes/img/awesomecv_award.svg)
+
 ### Date Formatter
 
 `date_formatter()` is a helper function to format dates in the resume.
 
+```{r}
+work
+```
+
 ```r
 work |>
  format_date(
- start = "date_start",
- end = "date_end",
+ start = "start",
+ end = "end",
  date_format = "%Y",
  sep = "->",
  sort_by = "start"
  ) |>
  resume_entry()
-```
+```
+
+![](vignettes/img/awesomecv_work.svg)

vignettes/gallery.qmd

@@ -13,6 +13,7 @@ listing:
  author: Kazuharu Yanagimoto
  image: img/cv_yanagimoto.svg
  path: https://kazuyanagimoto.com/cv/cv.pdf
+ description: CSV Data + GitHub Actions
  links:
  - name: Code
  url: https://github.com/kazuyanagimoto/cv