From 687c36f32657a3711569ac7c18ed69a896f48c51 Mon Sep 17 00:00:00 2001 From: James Cook Date: Thu, 14 Sep 2023 19:54:48 +0100 Subject: [PATCH] docs: update announcements docs --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dc89f99..26c4fab 100644 --- a/README.md +++ b/README.md @@ -257,15 +257,26 @@ 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 const announcements = await client.getAnnouncements(); console.log(announcements); + +/** + { + success: 1, + data: [ + { + id: 321453, + title: "A big announcement", + description: "

School will be closing early today!

", + ... + } + ], + meta: [] +} +*/ ``` ## `.getDetentions`