Merge tag 'v0.1.0' into develop

v0.1.0 v0.1.0

Author: Suiram1701

README.md

@@ -1,2 +1,43 @@
 # WebUntisAPI.Client
-Documentation will follow after initial publication.
+
+This .NET library allows you to connect you with a WebUntis account and load all of the data you need from there.<br>
+
+## Download sources:
+- [![GitHub](https://img.shields.io/badge/GitHub-Releases-black)](https://github.com/Suiram1701/WebUntisAPI.Client/releases)<br>
+- [![NuGet](https://img.shields.io/badge/NuGet-Package-blue)](https://www.nuget.org/packages/WebUntisAPI.Client)
+
+## Documentation:
+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:
+
+### Add references to this library
+The simplest way is to add the [NuGet](https://www.nuget.org/packages/WebUntisAPI.Client) package to your project,
+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
+
+### 1. Creating a client and login:
+
+```C#
+using (WebUntisClient client = new WebUntisClient("App name"))
+{
+    await client.LoginAsync("example.webuntis.com", "exampleSchool", "username", "password")
+    // Here can you send your requests
+}
+```
+Overloads:<br>
+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.
+
+Remarks:<br>
+- When you use the client in a using statement you would automatically logged out when it disposed
+- 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.
+
+### 2. Send requests
+After your login you can send requests to get informations about your timetable and all about.<br>
+The methods an what they do shoud be self-explained.<br>
+
+## Issues
+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 by your problem.
+[![GitHub](https://img.shields.io/badge/GitHub-Issues-red)](https://github.com/Suiram1701/WebUntisAPI.Client/issues)
+
+<hr>
+
+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).
+

WebUntisAPI.Client/Converter/ClassJsonConverter.cs

@@ -2,11 +2,6 @@
 using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Runtime.Serialization.Formatters;
-using System.Text;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Models;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/ColorJsonConverter.cs

@@ -1,12 +1,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections.Generic;
 using System.Drawing;
-using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Extensions;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/DateJsonConverter.cs

@@ -1,10 +1,6 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Extensions;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/StatusDataJsonConverter.cs

@@ -2,10 +2,7 @@
 using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
-using System.Drawing;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Models;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/TimeJsonConverter.cs

@@ -1,10 +1,6 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Extensions;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/TimegridJsonConverter.cs

@@ -3,9 +3,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using WebUntisAPI.Client.Extensions;
 using WebUntisAPI.Client.Models;
 
 namespace WebUntisAPI.Client.Converter

WebUntisAPI.Client/Converter/TimetableRequestModelJsonConverter.cs

@@ -1,10 +1,6 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using WebUntisAPI.Client.Extensions;
 using WebUntisAPI.Client.Models;
 

WebUntisAPI.Client/Enums.cs

@@ -1,9 +1,4 @@
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace WebUntisAPI.Client
 {

WebUntisAPI.Client/Exceptions/WebUntisException.cs

@@ -1,11 +1,6 @@
 using Newtonsoft.Json;
 using System;
-using System.Collections.Generic;
 using System.Diagnostics;
-using System.Linq;
-using System.Runtime.Serialization;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace WebUntisAPI.Client.Exceptions
 {