james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 11:58:13 +00:00
Code Activity

feat: Small docs improvements (#29)

Browse source
This commit is contained in:
James 2023-05-04 22:39:55 +01:00 • committed by GitHub
parent 451f80062c
commit 86df2e0927
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/README.md
View file

@ -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

2
docs/index.html
View file

@ -34,5 +34,7 @@
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
</body>
</html>