Initial commit
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Virtueller Stundenplan
|
||||
|
||||
This project is a unofficial NodeJS library for the [Virtueller Stundenplan](https://virtueller-stundenplan.org).
|
||||
|
||||
# Installation
|
||||
|
||||
You can install this library from [npm](https://npmjs.com/package/virtueller-stundenplan).
|
||||
|
||||
# Usage
|
||||
|
||||
This is a example on how to use the package:
|
||||
|
||||
```javascript
|
||||
const { VirtuellerStundenplan } = require("virtueller-stundenplan");
|
||||
|
||||
const vs = new VirtuellerStundenplan("user@example.com", "Password");
|
||||
|
||||
(async() => {
|
||||
const timetable = await vs.getMyTimetable();
|
||||
|
||||
console.log(timetable);
|
||||
})()
|
||||
```
|
||||
|
||||
# Note
|
||||
|
||||
This project in **very early developement**, except things to break and change.
|
||||
Reference in New Issue
Block a user