From b599e6d74d3afe1c739fcacb45f3231cc1815722 Mon Sep 17 00:00:00 2001 From: James Cook Date: Thu, 4 May 2023 22:38:41 +0100 Subject: [PATCH] add info box to un meta --- docs/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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