diff --git a/README.md b/README.md index 3a0ff21..0a8a5cf 100644 --- a/README.md +++ b/README.md @@ -5,28 +5,5 @@ An Magis API written with and for python [![Python package](https://github.com/StoppedwummPython/pygis/actions/workflows/python-package.yml/badge.svg)](https://github.com/StoppedwummPython/pygis/actions/workflows/python-package.yml) -## Installation - -Obtain the files to the API, then move it to your project - -```python -import pygis -``` - -## Functions -### Login -Log into the session with -```python -import pygis -ms = pygis.magisSession(frontend, backend, webdav) -ms.login(username, pwd) -``` - -`ms.login` will return an `user` object. - -### Obtain Infos -You can obtain your courses with `.getCourses()`. - -`.getApps` returns all Apps. - -`.getUsers` returns all Users. +## Quickstart +