New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #24

Open

5 tasks done

arthur-shaw opened this issue Jan 27, 2024 · 0 comments

Assignees

Labels

documentation 📝 solved but not yet published ✅

Contributor

arthur-shaw commented Jan 27, 2024 •

edited

Loading

Make a few improvements largely patterned after R/pkgdown conventions. In particular:

Add hex, pkgdown-style. See here
Add experimental badge. See here.
Add installation heading and instructions
Add goals/objectives of package. See here
Add a small usage section--a super svelte version of a getting started vignette. See here

arthur-shaw added the documentation 📝 label

arthur-shaw self-assigned this

This was referenced Feb 1, 2024

Redraft README in style of R package #27

Merged

Improve README lsms-worldbank/selector#16

Open

arthur-shaw added the solved but not yet published ✅ label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment