doc: update project metadata

DESCRIPTION

@@ -1,15 +1,17 @@
 Package: rdeps
 Type: Package
-Title: The Title of the Project
+Title: Identify External Packages Used in a Project
 Version: 0.0.0.9000
 Authors@R: c(
     person(given   = "Nicolas",
            family  = "Casajus",
            role    = c("aut", "cre", "cph"),
            email   = "[email protected]",
            comment = c(ORCID = "0000-0002-5537-5294")))
-Description: A paragraph providing a full description of the project (on 
-    several lines...)
+Description: Screens all '.R', '.Rmd', and '.qmd' files to extract the name of
+    packages used in a project. This package detects packages called with 
+    'library(foo)', 'require(foo)', and 'foo::bar()' and adds these dependencies
+    in the DESCRIPTION file in the sections Depends, Imports, and Suggests.
 URL: https://github.com/frbcesab/rdeps
 BugReports: https://github.com/frbcesab/rdeps/issues
 License: GPL (>= 2)

README.Rmd

@@ -33,25 +33,37 @@ rdeps <img src="man/figures/package-sticker.png" align="right" style="float:righ
   • <a href="#features">Features</a><br>
   • <a href="#installation">Installation</a><br>
   • <a href="#get-started">Get started</a><br>
-  • <a href="#long-form-documentations">Long-form documentations</a><br>
   • <a href="#citation">Citation</a><br>
-  • <a href="#contributing">Contributing</a><br>
-  • <a href="#acknowledgments">Acknowledgments</a><br>
-  • <a href="#references">References</a>
+  • <a href="#contributing">Contributing</a>
 </p>
 
 
 
 ## Overview
 
-
-The R package `rdeps`... **{{ DESCRIBE YOUR PACKAGE }}**
+The goal of the R package `rdeps` is to provide a tool to identify all external 
+packages used in a project (package, compendium, website, etc.) and to list
+them in the [`DESCRIPTION`](https://r-pkgs.org/description.html) file.
 
 
 
 ## Features
 
-The main purpose of `rdeps` is to... **{{ DESCRIBE THE MAIN FEATURES }}**
+`rdeps` screens all `.R`, `.Rmd`, and `.qmd` files to extract the name of
+packages used in a project. This package detects packages called with 
+`library(foo)`, `require(foo)`, and `foo::bar()` and adds these dependencies
+to the `DESCRIPTION` file in the sections _Depends_, _Imports_, and _Suggests_.
+
+Different types of dependencies are handle:
+
+- if the package is called with `library(foo)` or `require(foo)`, 
+it will be added to the section **Depends** of the `DESCRIPTION` file 
+(except for vignettes and tests);
+- if the package is called with `foo::bar()`,
+it will be added to the section **Imports** of the `DESCRIPTION` file
+(except for vignettes and tests);
+- if the package is only used in vignettes or tests,
+it will be added to the section **Suggests** of the `DESCRIPTION` file.
 
 
 
@@ -85,23 +97,13 @@ vignette.
 
 
 
-## Long-form documentations
-
-`rdeps` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more about the package:
-
-- the [Get started](https://frbcesab.github.io/rdeps/articles/rdeps.html)
-vignette describes the core features of the package
-- **{{ LIST ADDITIONAL VIGNETTES }}**
-
-
-
 ## Citation
 
 Please cite `rdeps` as: 
 
 > Casajus Nicolas (`r format(Sys.Date(), "%Y")`) rdeps: An R 
-package to **{{ TITLE }}**. R package version 0.0.0.9000. 
-<https://github.com/frbcesab/rdeps/>
+package to identify external packages used in a project. R package version 0.0.0.9000,
+<https://github.com/frbcesab/rdeps/>.
 
 
 
@@ -113,15 +115,3 @@ check out our [Contributor Guidelines](https://github.com/frbcesab/rdeps/blob/ma
 Please note that the `rdeps` project is released with a 
 [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
 By contributing to this project, you agree to abide by its terms.
-
-
-
-## Acknowledgments
-
-**{{ OPTIONAL SECTION }}**
-
-
-
-## References
-
-**{{ OPTIONAL SECTION }}**

README.md

@@ -22,20 +22,35 @@ coverage](https://github.com/frbcesab/rdeps/actions/workflows/test-coverage.yaml
 <a href="#features">Features</a><br> •
 <a href="#installation">Installation</a><br> •
 <a href="#get-started">Get started</a><br> •
-<a href="#long-form-documentations">Long-form documentations</a><br> •
 <a href="#citation">Citation</a><br> •
-<a href="#contributing">Contributing</a><br> •
-<a href="#acknowledgments">Acknowledgments</a><br> •
-<a href="#references">References</a>
+<a href="#contributing">Contributing</a>
 </p>
 
 ## Overview
 
-The R package `rdeps`… **{{ DESCRIBE YOUR PACKAGE }}**
+The goal of the R package `rdeps` is to provide a tool to identify all
+external packages used in a project (package, compendium, website, etc.)
+and to list them in the
+[`DESCRIPTION`](https://r-pkgs.org/description.html) file.
 
 ## Features
 
-The main purpose of `rdeps` is to… **{{ DESCRIBE THE MAIN FEATURES }}**
+`rdeps` screens all `.R`, `.Rmd`, and `.qmd` files to extract the name
+of packages used in a project. This package detects packages called with
+`library(foo)`, `require(foo)`, and `foo::bar()` and adds these
+dependencies to the `DESCRIPTION` file in the sections *Depends*,
+*Imports*, and *Suggests*.
+
+Different types of dependencies are handle:
+
+- if the package is called with `library(foo)` or `require(foo)`, it
+  will be added to the section **Depends** of the `DESCRIPTION` file
+  (except for vignettes and tests);
+- if the package is called with `foo::bar()`, it will be added to the
+  section **Imports** of the `DESCRIPTION` file (except for vignettes
+  and tests);
+- if the package is only used in vignettes or tests, it will be added to
+  the section **Suggests** of the `DESCRIPTION` file.
 
 ## Installation
 
@@ -63,22 +78,13 @@ library("rdeps")
 For an overview of the main features of `rdeps`, please read the [Get
 started](https://frbcesab.github.io/rdeps/articles/rdeps.html) vignette.
 
-## Long-form documentations
-
-`rdeps` provides **{{ NUMBER OF VIGNETTES }}** vignettes to learn more
-about the package:
-
-- the [Get
-  started](https://frbcesab.github.io/rdeps/articles/rdeps.html)
-  vignette describes the core features of the package
-- **{{ LIST ADDITIONAL VIGNETTES }}**
-
 ## Citation
 
 Please cite `rdeps` as:
 
-> Casajus Nicolas (2023) rdeps: An R package to **{{ TITLE }}**. R
-> package version 0.0.0.9000. <https://github.com/frbcesab/rdeps/>
+> Casajus Nicolas (2023) rdeps: An R package to identify external
+> packages used in a project. R package version 0.0.0.9000,
+> <https://github.com/frbcesab/rdeps/>.
 
 ## Contributing
 
@@ -90,11 +96,3 @@ Please note that the `rdeps` project is released with a [Contributor
 Code of
 Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
 By contributing to this project, you agree to abide by its terms.
-
-## Acknowledgments
-
-**{{ OPTIONAL SECTION }}**
-
-## References
-
-**{{ OPTIONAL SECTION }}**

inst/CITATION

@@ -2,7 +2,7 @@ citHeader("To cite rdeps in publications use:")
 
 bibentry(
   bibtype = "Manual",
-  title   = "rdeps: {An} {R} package to ...",
+  title   = "rdeps: {An} {R} package to identify external packages used in a project",
   author  = c(person("Casajus Nicolas")),
   year    = "2023",
   note    = "R package version 0.0.0.9000",