diff --git a/README.md b/README.md new file mode 100644 index 00000000..56bde81f --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# VTOP Chennai + +![License](https://img.shields.io/badge/license-GPL--3.0-orange) ![Release](https://vtopchennai.therealsuji.tk/release.svg) ![Downloads](https://vtopchennai.therealsuji.tk/downloads.svg) + +An android application to access the VTOP portal for the students of VIT Chennai. + +![Preview](/preview.gif) + +## Features + +- Sign in using your VTOP credentials to download your timetable, attendance, marks and other data. +- Get notifications on upcoming classes. +- Notification dots to for new marks, new announcements, failed attendance, etc. +- Get directions to get around the campus with Google maps and a campus map. +- Light and dark themes. + +## Download + +Get the latest stable version of this application from +the [download page](https://vtopchennai.therealsuji.tk/). + +## License + +``` +Copyright 2021 Sujit Kumar + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +``` + +## Disclaimer + +The developer of this application is a student of VIT Chennai and does not have any affiliation with +VIT itself. diff --git a/preview.gif b/preview.gif new file mode 100644 index 00000000..40c846e0 Binary files /dev/null and b/preview.gif differ