From 3046bc88ac1d929a58ec86d474572a39683030e0 Mon Sep 17 00:00:00 2001
From: Pavel Kirilin <win10@list.ru>
Date: Mon, 16 Dec 2019 00:30:22 +0400
Subject: [PATCH] Added project readme and fixed ci.

Signed-off-by: Pavel Kirilin <win10@list.ru>
---
 .gitlab-ci.yml |  1 +
 README.md      | 48 +++++++++++++++++++++++++++++++++++++-----------
 2 files changed, 38 insertions(+), 11 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 7a24269..305e8af 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -13,6 +13,7 @@ test:
 
 cleanup:
   stage: cleanup
+  when: always
   tags:
     - private
   script:
diff --git a/README.md b/README.md
index f145b31..b63c31d 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,37 @@
-## Corporate systems
-Perform following steps to comfortably start developing.
-1. Enable in Idea autoreloading project.
-    * Settings -> Build, execution .. ->  Compiler -> Build project automatically
-2. Enable File Watcher for statics as sa
-    * Install "File Watchers" plugin
-    * Enable it to compile sass and coffee on change.
-3. Run docker-compose up
-4. Change permissions on target folder
-    * chown $USER target/
-You're awesome.
\ No newline at end of file
+# Cinemas corporation system built on pure JavaEE
+[![Coverage report](https://gitlab.le-memese.com/s3rius/corporative_systems2/badges/master/coverage.svg?job=test)](https://gitlab.le-memese.com/s3rius/corporative_systems2)
+
+System that helps people to manage cinemas tickets and their customers.
+
+## We help You with your business
+This project will be convenient for your business in performing following actions:
+* Check stats of your cinema;
+* See all your customers info;
+* Manage your ticketing system.
+
+## Visual style
+
+Our project provides the best visual style built on top of modern design patterns.
+The best designers were involved such as Pavel Kirilin and Andrei Belousov.
+
+## Easy to run and deploy
+
+You can start boosting up your business by simple command `make run` on unix systems or `docker-compose up` on every other system.
+
+#### System requirements
+You can run it from everywhere, if it has maven or docker installed.
+
+### Also our service provides rich api with following endpoints
+
+* /api/{format}/{entity}/list
+* /api/{format}/{entity}/item/{id}
+
+Where formats can be:
+- json
+- xml
+- xlst
+
+And entities:
+- cinemas
+- users
+- tickets
\ No newline at end of file
-- 
GitLab