diff --git a/.gitignore b/.gitignore index 6a18ad4..aac56ca 100644 --- a/.gitignore +++ b/.gitignore @@ -94,3 +94,4 @@ ENV/ # Rope project settings .ropeproject +.vscode/settings.json diff --git a/README.md b/README.md index ebb3c39..2566051 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ # admidio-python-api -The objective of this interface is the ability to get data from an ![Admidio](https://github.com/admidio) installation and use them in python. Current planned interfaces are Users and Groups. \ No newline at end of file +The objective of this interface is the ability to get data from an ![Admidio](https://github.com/admidio) installation and use them in python. Current planned interfaces are Users and Groups. + +There will be 3 modules available: + +* **Amidio** which has a list of all Groups and Users +* **Groups** which has a list of the current Users that are in the group +* **Users** which has all the profile data of a user