Merge pull request #41 from Tch1b0/enhance-docs

Enhance docs

Author: Tch1b0

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Generate docs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  gen-docs:
+    name: Generate docs and deploy to GitHub Pages
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup node.js
+        uses: actions/[email protected]
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build docs
+        run: npm run docs
+
+      - name: Deploy to GitHub Pages
+        if: success()
+        uses: crazy-max/ghaction-github-pages@v2
+        with:
+          target_branch: gh-pages
+          build_dir: docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
-practical-test
+practical-test
+docs

README.md

@@ -23,13 +23,13 @@ let t = await dm.getTimetable();
 console.log(t.entries[0].newSubject);
 ```
 
-```
+```bash
 English
 ```
 
 ## Documentation
 
-You can read the docs [on this Github Wiki](https://github.com/Tch1b0/dsbmobile.js/wiki).
+You can read the docs [right here](https://tch1b0.github.io/dsbmobile.js/).
 
 ## Contribute