From 759e5fc289f6e79f4a32fe65a1ced2d027bb84ea Mon Sep 17 00:00:00 2001
From: Tomas Havlicek <xhavlic@fi.muni.cz>
Date: Tue, 14 Jun 2022 17:41:40 +0200
Subject: [PATCH] feat: added REST API

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index b0582c1..cb2e5cc 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,16 @@ To login to Adminer in your browser you need to specify:
 * Password: same as `DB_PASSWORD` in your .env file
 * Database: same as `DB_NAME` in your .env file
 
+
+## REST API
+
+| requirement |endpoint | method | criteria |
+| ------------- | ------------- | ------------- | ------------- |
+| Search for a movie | /search  | get | returns array of movies as a result of search
+| Show a single movie | /movie/:id  | get | return movie 
+| Show popular movies | /movie/preview  | get | returns array of few movies (popular) to preview
+| Show a single director  | /director/:id | get | returns array of few movies (popular) to preview
+
 ## TODO
 
 More TBA as features are implemented.
-- 
GitLab