Fixed readme file

Author: Jegors Čemisovs

README.md

@@ -0,0 +1,49 @@
+## About
+
+This project demonstrates the capabilities of the Spring Shell framework, as well as testing examples using the Spock
+Framework.
+
+The solution of the [HyperMetro](https://hyperskill.org/projects/120) project was taken as the basis. This is a console
+application that loads a subway map and allows you to execute various commands to work with the metro schema.
+
+In particular, you can find the shortest or fastest route between stations, print various reports, and edit the metro
+map.
+
+## Technologies used
+
+When creating this project, I used:
+
+- Java 17
+- Gradle
+- Spring Boot + Spring Shell
+- Jackson JSON parser
+- Spock Framework
+
+## How to build and run the project
+
+To build the application use this command:
+
+`./gradlew bootJar`
+
+In order to run the application you should specify a metro schema as argument:
+
+`$ java -jar build/libs/hypermetro-1.0-SNAPSHOT.jar london.json`
+
+## Commands
+
+- add-head line station
+- append line station
+- remove line station
+- connect line1 station1 line2 station2
+- output line
+- route line1 station1 line2 station2
+- fastest-route line1 station1 line2 station2
+
+## Documentation
+
+You may check the report and the documentation:
+- [JavaDoc](https://rabestro.github.io/hypermetro/docs/javadoc) for the program
+- [Specifications](https://rabestro.github.io/hypermetro/docs/spock-reports) by Spock Reports
+- [Tests Coverage](https://rabestro.github.io/hypermetro/docs/coverage) report
+- [Gradle unit test](https://rabestro.github.io/hypermetro/docs/reports/test) report
+

CNAME docs/CNAME

@@ -16,13 +16,15 @@
 import java.util.Map;
 import java.util.NoSuchElementException;
 
+import static java.lang.System.Logger.Level.INFO;
 import static java.util.Objects.requireNonNull;
 
 /**
  * Repository interface implementation that loads a metro map from a JSON file
  */
 @Repository
 public class MetroRepositoryJson implements MetroRepository, InitializingBean {
+    private static final System.Logger LOGGER = System.getLogger(MetroRepositoryJson.class.getName());
 
     private static final TypeReference<Map<String, Deque<Station>>> SCHEMA_TYPE = new TypeReference<>() {
     };
@@ -37,7 +39,9 @@ public class MetroRepositoryJson implements MetroRepository, InitializingBean {
 
     @Override
     public void afterPropertiesSet() throws Exception {
+        LOGGER.log(INFO, "Loading metro schema from file: „{0}“", schemaPath);
         metroMap = new JsonMapper().readValue(schemaPath.toFile(), SCHEMA_TYPE);
+        LOGGER.log(INFO, "Metro map successfully loaded.");
     }
 
     @Override
@@ -51,6 +55,7 @@ private Deque<Station> getLine(String line) {
 
     @Override
     public void addHead(String line, String station, int time) {
+        LOGGER.log(INFO, "Executing command: add-head „{0}“ „{1}“ „{2}“", line, station, time);
         var metroLine = getLine(line);
         var metroStation = new Station(station, time);
 
@@ -66,6 +71,7 @@ public void addHead(String line, String station, int time) {
 
     @Override
     public void append(String line, String station, int time) {
+        LOGGER.log(INFO, "Executing command: append „{0}“ „{1}“ „{2}“", line, station, time);
         var metroLine = getLine(line);
         var metroStation = new Station(station, time);
 
@@ -81,11 +87,14 @@ public void append(String line, String station, int time) {
 
     @Override
     public void remove(String line, String station) {
+        LOGGER.log(INFO, "Executing command: remove „{0}“ „{1}“", line, station);
         throw new UnsupportedOperationException("This operation has not yet been implemented");
     }
 
     @Override
     public void connect(String sourceLine, String sourceStation, String targetLine, String targetStation) {
+        LOGGER.log(INFO, "Executing command: connect „{0}“ „{1}“ „{2}“ „{3}“",
+                sourceLine, sourceStation, targetLine, targetStation);
         var source = getStation(sourceLine, sourceStation);
         var target = getStation(targetLine, targetStation);
         source.transfer().add(new StationId(targetLine, targetStation));