diff --git a/README.md b/README.md index 48a70de..028cf92 100644 --- a/README.md +++ b/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 \ No newline at end of file +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. +photo-2024-02-18-13-36-59 +#### Checking site. +photo-2024-02-18-13-40-25 +#### Check page. +photo-2024-02-18-13-42-12 +#### Click on link go to the information page. +photo-2024-02-18-13-45-41 +#### Click on the test button to start the test. +photo-2024-02-18-13-49-30 \ No newline at end of file