Skip to content

Commit

Permalink
documented getHomeworkDescription()
Browse files Browse the repository at this point in the history
  • Loading branch information
chopster44 committed Mar 25, 2023
1 parent 6e15d44 commit 433b486
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ When you create an instance it does not log into edulink. So you need to run:
```ts
await edulink.Authenticate();
```
No arguments are required as they are collected on the creation of a instance.
No arguments are required as they are collected on the creation of an instance.


### Get Timetable:
Expand Down Expand Up @@ -84,5 +84,12 @@ await edulink.getCurrentHomework();
```
The function `getPastHomework()`, returns all past homework in the type `HomeworkResult`.

### Other homework related data:

```ts
await edulink.getHomeworkDescription({id: "12345", source: "Edulink"});
```
The function `getHomeworkDescription()`, takes the `id` of the homework and `"Edulink"` as the source(*)

## Other info
(*) - if this symbol is used then the functionality of the feature being talked about is not fully known.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "edulinkone-api",
"version": "1.1.2",
"version": "1.1.3",
"description": "A custom-built unofficial api for OvernetData's Edulinkone",
"homepage": "https://github.com/chopster44/edulinkone-api#readme",
"bugs": {
Expand Down

0 comments on commit 433b486

Please sign in to comment.