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

update readme

Browse source
This commit is contained in:
James Cook 2023-05-04 21:49:12 +01:00
parent b45bae16af
commit e1ee21e0a1
1 changed files with 13 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

33
readme.md
View file

@ -1,29 +1,22 @@
# Classcharts API
A client for the classcharts API
![Discord](https://img.shields.io/discord/918103752068726855)
![npm](https://img.shields.io/npm/dm/classcharts-api)
![NPM](https://img.shields.io/npm/l/classcharts-api)
![npm](https://img.shields.io/npm/v/classcharts-api)
![node-current](https://img.shields.io/node/v/classcharts-api)
A typescript wrapper for getting information from the Classcharts API.
# Links
- [Documentation](https://classchartsapi.github.io/classcharts-api-js/)
- [API Documentation (with library examples)](https://classchartsapi.github.io/api-docs/#introduction)
- [Discord](https://discord.gg/DTcwugcgZ2)
# Examples
# Contributing
Docs are very much a WIP, for any help with the library, please join the discord above
Contributions are welcome! There are lots of API endpoints which we simply do not have access to to implement, so if you have access to them, please consider contributing! If you have any questions, feel free to ask in the [discord](https://discord.gg/DTcwugcgZ2).
```typescript
import { StudentClient } from "classcharts-api";
async function main() {
const client = new StudentClient("classchartsCode", "01/1/2000");
await client.login();
console.log(
await client.getBehaviour({
from: "20/01/2000",
to: "01/02/2000",
})
);
console.log(await client.getActivity());
console.log(await client.getStudentInfo());
}
# Help
main();
```
For any help with the library, please join the [discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get help from the community.