update README.md

README.md

@@ -1,7 +1,32 @@
-### Hexlet tests and linter status:
+### Tests and linter status:
 [![Actions Status](https://github.com/kitdim/java-project/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/kitdim/java-project/actions)
 [![Actions Status](https://github.com/kitdim/java-project/actions/workflows/java_ci.yml/badge.svg)](https://github.com/kitdim/java-project/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/dcb01f6a48a0e5d034a4/maintainability)](https://codeclimate.com/github/kitdim/java-project/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/dcb01f6a48a0e5d034a4/test_coverage)](https://codeclimate.com/github/kitdim/java-project/test_coverage)
+### SEO KIT
+This project is a website for checking other websites for SEO suitability.
+Based on Javalin a lightweight Java and Kotlin web framework. Web design made with Bootstrap.
 ### Deploy
-link: https://seo-kd.onrender.com
+link: https://seo-kd.onrender.com
+### Requirements
+* JDK 20
+* Gradle 8.3
+* Makefile (optional, simplifies start-up)
+* Docker 
+### Usage
+1. Clone app from GitHub.
+2. Run app on Docker or use gradle:
+   ./gradlew run 
+
+   ./gradlew test
+### Example
+#### Main page.
+<a href="https://ibb.co/s2d1PMc"><img src="https://i.ibb.co/6m7tZfG/photo-2024-02-18-13-36-59.jpg" alt="photo-2024-02-18-13-36-59" border="0"></a>
+#### Checking site.
+<a href="https://ibb.co/DM7TY4n"><img src="https://i.ibb.co/c8NVwJd/photo-2024-02-18-13-40-25.jpg" alt="photo-2024-02-18-13-40-25" border="0"></a>
+#### Check page.
+<a href="https://ibb.co/Wk1yGn1"><img src="https://i.ibb.co/ZBC8GdC/photo-2024-02-18-13-42-12.jpg" alt="photo-2024-02-18-13-42-12" border="0"></a>
+#### Click on link go to the information page.
+<a href="https://ibb.co/BtZHBqL"><img src="https://i.ibb.co/t4swD8B/photo-2024-02-18-13-45-41.jpg" alt="photo-2024-02-18-13-45-41" border="0"></a>
+#### Click on the test button to start the test.
+<a href="https://ibb.co/WgDfVVB"><img src="https://i.ibb.co/2g8dZZc/photo-2024-02-18-13-49-30.jpg" alt="photo-2024-02-18-13-49-30" border="0"></a>