docs

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(global_search)
 export(universe_ls)
 export(universe_package)
 export(universe_packages)

R/universe.R

@@ -1,6 +1,6 @@
 #' All packages in an universe
 #'
-#' @param universe Name of the universe (character of length 1)
+#' @inheritParams universe_search
 #'
 #' @return A character vector of all packages in the universe.
 #' @export
@@ -25,8 +25,7 @@ universe_ls <- function(universe) {
 
 #' Info on all packages in an universe
 #'
-#' @param universe Name of the universe (character of length 1)
-#' @param limit Number of results to return (integer of length 1)
+#' @inheritParams universe_search
 #'
 #' @return A list with information on all packages in the universe.
 #' @export
@@ -51,7 +50,7 @@ universe_packages <- function(universe, limit = 100) {
 
 #' Info on a single packages in an universe
 #'
-#' @param universe Name of the universe (character of length 1)
+#' @inheritParams universe_search
 #' @param package Name of the package (character of length 1)
 #'
 #' @return A list with information on the package.

README.Rmd

@@ -30,12 +30,35 @@ You can install the development version of starchart from [GitHub](https://githu
 pak::pak("ropenscilabs/starchart")
 ```
 
-## Example
+## Examples
 
-This is a basic example which shows you how to solve a common problem:
+### All packages in an universe
 
 ```{r example}
 library(starchart)
 universe_ls("jeroen")
+```
+
+### Info on all packages in an universe
+
+```{r}
 universe_packages("jeroen", limit = 1)
 ```
+
+### Info on a single package in an universe
+
+```{r}
+universe_package("jeroen", package = "curl")
+```
+
+### Search within a single universe
+
+```{r}
+universe_search("ropensci", query = 'needs:httr2', limit = 1)
+```
+
+### Search among all universes
+
+```{r}
+global_search(query = '"weather data"', limit = 1)
+```