readme

.Rbuildignore

@@ -3,3 +3,4 @@
 ^LICENSE\.md$
 ^man/universe_query\.Rd$
 ^\.github$
+^README\.Rmd$

README.Rmd

@@ -0,0 +1,57 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# starchart
+
+<!-- badges: start -->
+  [![R-CMD-check](https://github.com/ropenscilabs/starchart/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropenscilabs/starchart/actions/workflows/R-CMD-check.yaml)
+  <!-- badges: end -->
+
+The goal of starchart is to access the R-universe API.
+
+## Installation
+
+You can install the development version of starchart from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("pak")
+pak::pak("ropenscilabs/starchart")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+library(starchart)
+universe_ls("jeroen")
+universe_packages("jeroen", limit = 1)
+```
+
+What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
+
+```{r cars}
+summary(cars)
+```
+
+You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
+
+You can also embed plots, for example:
+
+```{r pressure, echo = FALSE}
+plot(pressure)
+```
+
+In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.