From e6c475af72762307e95dc2b6f2d489b592ebe6b5 Mon Sep 17 00:00:00 2001
From: psmagin <Pavlo_Smahin@epam.com>
Date: Tue, 23 Aug 2022 18:01:46 +0300
Subject: [PATCH] MODELINKS-1 Update README

---
 README.md                                     | 47 ++++++++++++++++++-
 doc/documentation.md                          |  2 +
 .../swagger.api/mod-entities-links.yaml       |  2 +-
 3 files changed, 48 insertions(+), 3 deletions(-)
 create mode 100644 doc/documentation.md

diff --git a/README.md b/README.md
index 20bfcb60..3f803943 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,49 @@
-# mod-search
+# mod-entities-links
 
-Copyright (C) 2020-2021 The Open Library Foundation
+Copyright (C) 2020-2022 The Open Library Foundation
 
 This software is distributed under the terms of the Apache License,
 Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
+
+## Table of contents
+
+  * [Introduction](#introduction)
+  * [Additional Information](#additional-information)
+    * [Issue tracker](#issue-tracker)
+    * [API Documentation](#api-documentation)
+    * [Module Documentation](#module-documentation)
+    * [Code analysis](#code-analysis)
+    * [Download and configuration](#download-and-configuration)
+    * [Development tips](#development-tips)
+
+
+## Introduction
+
+This module provides a storing and processing functionality for links between entities.
+
+## Additional Information
+### Issue tracker
+
+See project [MODELINKS](https://issues.folio.org/browse/MODELINKS)
+at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker/).
+
+### API Documentation
+
+This module's [API documentation](https://dev.folio.org/reference/api/#mod-entities-links).
+
+### Module Documentation
+This module's [Documentation](doc/documentation.md)
+
+### Code analysis
+
+[SonarQube analysis](https://sonarcloud.io/dashboard?id=org.folio%3Amod-entities-links).
+
+### Download and configuration
+
+The built artifacts for this module are available.
+See [configuration](https://dev.folio.org/download/artifacts) for repository access,
+and the [Docker image](https://hub.docker.com/r/folioorg/mod-entities-links/)
+
+### Development tips
+
+The development tips are described on the following page: [Development tips](doc/development.md)
diff --git a/doc/documentation.md b/doc/documentation.md
new file mode 100644
index 00000000..0fc7a050
--- /dev/null
+++ b/doc/documentation.md
@@ -0,0 +1,2 @@
+# Entities-Links Documentation
+
diff --git a/src/main/resources/swagger.api/mod-entities-links.yaml b/src/main/resources/swagger.api/mod-entities-links.yaml
index 4d42e5e6..94eb4bf6 100644
--- a/src/main/resources/swagger.api/mod-entities-links.yaml
+++ b/src/main/resources/swagger.api/mod-entities-links.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Search API
+  title: Entities Links API
   version: v1.0
   description: Entity Links API