Skip to content

Commit 42524de

Browse files
committed
add docs to README
1 parent 33167d4 commit 42524de

1 file changed

Lines changed: 33 additions & 3 deletions

File tree

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,42 @@
11
# WebUntisAPI.Client
22

33
This .NET library allows you to connect you with a WebUntis account and load all of the data you need from there.<br>
4-
[![Documentation](https://img.shields.io/badge/GitHub-Documentation-red)](https://github.com/Suiram1701/WebUntisAPI.Client/wiki)
54

6-
### Download sources:
7-
- [![GitHub](https://img.shields.io/badge/GitHub-Releases-white)](https://github.com/Suiram1701/WebUntisAPI.Client/releases)<br>
5+
## Download sources:
6+
- [![GitHub](https://img.shields.io/badge/GitHub-Releases-black)](https://github.com/Suiram1701/WebUntisAPI.Client/releases)<br>
87
- [![NuGet](https://img.shields.io/badge/NuGet-Package-blue)](https://www.nuget.org/packages/WebUntisAPI.Client)
98

9+
## Documentation:
10+
The documentation is integrated in the package so that all classes and methods explain what they do. Here're the basics to use the library:
11+
12+
### Add references to this library
13+
The simplest way is to add the [NuGet](https://www.nuget.org/packages/WebUntisAPI.Client) package to your project,
14+
but when you don't want to use NuGet you can also download the [binarys](https://github.com/Suiram1701/WebUntisAPI.Client/releases) of the package and add the reference the contained .dll
15+
16+
### 1. Creating a client and login:
17+
18+
```C#
19+
using (WebUntisClient client = new WebUntisClient("App name"))
20+
{
21+
await client.LoginAsync("example.webuntis.com", "exampleSchool", "username", "password")
22+
// Here can you send your requests
23+
}
24+
```
25+
Overloads:<br>
26+
The `LoginAsync()` method has an overload where you can use instead of the `serverName` and the `loginName` an instance of `School` that returned from the school search.
27+
28+
Remarks:<br>
29+
- When you use the client in a using statement you would automatically logged out when it disposed
30+
- Under no circumstances should 10 req. per sec., more than 1800req. per hr (but in no case more than 3600 req. per hr). If the specifications are exceeded, access to WebUntis could permanently blocked by the WebUntis API.
31+
32+
### 2. Send requests
33+
After your login you can send requests to get informations about your timetable and all about.<br>
34+
The methods an what they do shoud be self-explained.<br>
35+
36+
## Issues
37+
When you had an error that you don't understand or you don't understand how you can use the library you can create an issue so that I can help you ba your problem.
38+
[![GitHub](https://img.shields.io/badge/GitHub-Issues-red)](https://github.com/Suiram1701/WebUntisAPI.Client/issues)
39+
1040
<hr>
1141

1242
This is an unofficial library that I created from the WebUntis API [documentation](https://untis-sr.ch/wp-content/uploads/2019/11/2018-09-20-WebUntis_JSON_RPC_API.pdf).

0 commit comments

Comments
 (0)