Skip to content

Commit

Permalink
update: package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomeriko96 committed Jan 5, 2024
1 parent 8b3dfa1 commit e655441
Show file tree
Hide file tree
Showing 2 changed files with 1,298 additions and 41 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ It is also possible to install from CRAN:
install.packages("vvcanvas")
```

## Features
To see which functions are available in which section based on the CANVAS LMS API structure, please refer to the reference page of the `vvcanvas` package. The [reference](https://vusaverse.github.io/vvcanvas/reference/index.html) page provides a comprehensive list of functions available in the package, organized by category.

Additionally, the package includes vignettes that provide more detailed information on how to use the functions in the package.

## Getting Started

To begin using the `vvcanvas` package, you need to authenticate with the Canvas LMS API by obtaining an API key and base URL. Follow these steps to get started:
Expand Down

0 comments on commit e655441

Please sign in to comment.