Merge branch 'master' of https://github.com/N1ghtF1re/Bsuir-Additiona…

…l-Api

README.md

@@ -1,2 +1,21 @@
-# Bsuir-Additional-Api
-Expansion of the standard API for BSUIR IIS. Includes, for example, a search for free audiences.
+<h1 align="center">Bsuir-Additional-Api</h1>
+<p align="center"><img src="https://pbs.twimg.com/profile_images/521395106/bsuir_logo_400x400.GIF" height=150></p>
+
+<p align="center">
+<a href="https://github.com/N1ghtF1re/Bsuir-Additional-Api/stargazers"><img src="https://img.shields.io/github/stars/N1ghtF1re/Bsuir-Additional-Api.svg" alt="Stars"></a>
+<a href="https://github.com/N1ghtF1re/Bsuir-Additional-Api/releases"><img src="https://img.shields.io/badge/downloads-4-brightgreen.svg" alt="Total Downloads"></a>
+<a href="https://github.com/N1ghtF1re/Bsuir-Additional-Api/releases"><img src="https://img.shields.io/github/tag/N1ghtF1re/Bsuir-Additional-Api.svg" alt="Latest Stable Version"></a>
+<a href="https://github.com/N1ghtF1re/Bsuir-Additional-Api/blob/master/LICENSE"><img src="https://img.shields.io/github/license/N1ghtF1re/Bsuir-Additional-Api.svg" alt="License"></a>
+</p>
+</p>
+
+## About the project
+This project expands of the standard API for BSUIR IIS. Includes, for example, a search for free audiences.
+
+## Implemented functionality
+- Search for free auditoriums
+- View all audiences, including filters
+- View all buildings with available floors
+
+## Documentation
+Detailed documentation on api methods located [here](https://github.com/N1ghtF1re/Bsuir-Additional-Api/tree/master/api-docs)