README not presented at AWS CodeArtifact

Question

I wish to present a README file on CodeArtifact. I deployed a new version that contains a README.MD file however the Description (marked in red) is still greyed out.

Found an AWS documentation however I did not understand what I should do to present my .MD file.

• can view the README at Bitbucket and inside the Intellij.
• code is in Java.
• use Maven for project management.

Following @Ermiya Eskandary comment, I made two README files, one in the root and a second in root of the module. After redeploying, the description is still not showing.

Project structure:

The POM file of the relevant module:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>---</artifactId>
        <groupId>---</groupId>
        <version>1.0.2</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>
    <artifactId>---</artifactId>
    <version>1.0.14</version>

    <dependencies>
        <dependency>
            <groupId>---</groupId>
            <artifactId>---</artifactId>
            <version>1.0.2</version>
        </dependency>
    </dependencies>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

</project> 

Answer 1

Unfortunately CodeArtifact does not currently support displaying Readme files for Maven packages. The GetPackageVersionReadme API will return "not found" for all Maven packages.

$ aws codeartifact get-package-version-readme \
>     --domain test \
>     --repo my-repo-name \
>     --format maven \
>     --package commons-lang \
>     --namespace commons-lang \
>     --package-version 2.1 \
>     --profile my_profile_name

An error occurred (ResourceNotFoundException) when calling the GetPackageVersionReadme operation: The readme file of this package version is not found