diff --git a/.gitignore b/.gitignore index 815af20..2b61141 100644 --- a/.gitignore +++ b/.gitignore @@ -118,4 +118,5 @@ dist .pnp.* tests/config.json -tests/sandbox.js \ No newline at end of file + +docs/typedoc \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 868b1c3..18817b4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -36,7 +36,13 @@ For any help with the library, please join the [discord](https://discord.gg/DTcw ```bash npm install classcharts-api # npm +``` + +```bash yarn add classcharts-api # yarn +``` + +```bash pnpm add classcharts-api # pnpm ``` @@ -230,6 +236,8 @@ console.log(badges); ## `.getAnnouncements` +?> This method does not include `meta` in the response, since I do not have access to this endpoint to test it. If you have access to this endpoint, please open a PR to add the `meta` response. Thanks! + Gets all announcements. ```typescript @@ -239,6 +247,8 @@ console.log(announcements); ## `.getDetentions` +?> This method does not include `meta` in the response, since I do not have access to this endpoint to test it. If you have access to this endpoint, please open a PR to add the `meta` response. Thanks! + Gets all detentions. ```typescript @@ -248,6 +258,8 @@ console.log(detentions); ## `.getAttendance` +?> This method does not include `meta` in the response, since I do not have access to this endpoint to test it. If you have access to this endpoint, please open a PR to add the `meta` response. Thanks! + Gets attendance. ```typescript diff --git a/docs/index.html b/docs/index.html index 5d950b1..7d11319 100644 --- a/docs/index.html +++ b/docs/index.html @@ -34,5 +34,7 @@ + +