started initial readme for repo (#122)

* started initial readme for repo

* added workflow badges

* readme edits

* spelling mistakes

* grammar fix

README.md

@@ -1 +1,21 @@
-# UGent-3
+# UGent-3 project peristerónas
+![tests](https://github.com/SELab-2/UGent-3/actions/workflows/ci-test-frontend.yaml/badge.svg?branch=development)
+![linter](https://github.com/SELab-2/UGent-3/actions/workflows/ci-linter-frontend.yaml/badge.svg?branch=development)
+![tests](https://github.com/SELab-2/UGent-3/actions/workflows/ci-test-backend.yaml/badge.svg?branch=development)
+![linter](https://github.com/SELab-2/UGent-3/actions/workflows/ci-linter-backend.yaml/badge.svg?branch=development)
+## Introduction
+Project peristerónas was created to aid both teachers and students in achieving a
+clear overview of deadlines and projects that need to be submitted.
+
+There's a separate functionality depending on if you're logged in as a teacher or as a student.
+For students the main functionality is to have a user-friendly interface to submit projects and check the correctness of their submissions.
+
+When a teacher is logged in they can get an overview of the projects he assigned and check how many students have already
+handed in a correct solution for example. It's also possible to edit the project and to grade projects in peristerónas' interface. 
+## Usage
+### Frontend
+For the developer instructions of the frontend please refer to the [frontend readme](frontend/README.md)
+where clear instructions can be found for usage, test cases, deployment and development.
+### Backend
+For the developer instructions of the backend please refer to the [backend readme](backend/README.md)
+where clear instructions can be found for usage, test cases, deployment and development.