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

docs: update package description

Browse source
This commit is contained in:
James Cook 2023-08-30 13:35:37 +01:00
parent 0d9d64cb07
commit 55d91a52b7
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/README.md
View file

@ -1,7 +1,7 @@
<p align="center"> <p align="center">
<h1 align="center">ClassCharts API JS</h1> <h1 align="center">ClassCharts API JS</h1>
<p align="center"> <p align="center">
A Node.js and Deno Typescript wrapper for getting information from the Classcharts API. A Node.js and Deno wrapper for getting information from the Classcharts API.
</p> </p>
</p> </p>
<p align="center"> <p align="center">
@ -63,7 +63,7 @@ session ID which will be used for all requests.
## Student Client ## Student Client
```typescript ```typescript
import { StudentClient } from "classcharts-api"; // Node.js import { StudentClient } from "classcharts-api";
// Date of birth MUST in the format DD/MM/YYYY // Date of birth MUST in the format DD/MM/YYYY
const client = new StudentClient("classchartsCode", "01/1/2000"); const client = new StudentClient("classchartsCode", "01/1/2000");

2
readme.md
View file

@ -7,7 +7,7 @@
<img alt="node-current" src="https://img.shields.io/node/v/classcharts-api"> <img alt="node-current" src="https://img.shields.io/node/v/classcharts-api">
</div> </div>
<p align="center">A Node.js and Deno Typescript wrapper for getting information from the Classcharts API.</p> <p align="center">A Node.js and Deno wrapper for getting information from the Classcharts API.</p>
# Links # Links