From df701825c3565eda0477fdb3cef2d189b0fa4436 Mon Sep 17 00:00:00 2001
From: Cristian G <113917899+cristianIOHK@users.noreply.github.com>
Date: Mon, 10 Jul 2023 10:49:28 -0400
Subject: [PATCH] feat: Update README.md (#83)

---
 .github/workflows/lint.yml |  6 ++---
 README.md                  | 51 +++++++++++++++++++++++++++++++++-----
 2 files changed, 48 insertions(+), 9 deletions(-)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 80265299a..651c37d65 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -26,9 +26,9 @@ jobs:
         with:
           token: ${{ secrets.ATALA_GITHUB_TOKEN }}
           fetch-depth: 0
-      - name: Mega-Linter
-        id: ml
-        uses: megalinter/megalinter@v6
+#      - name: Mega-Linter
+#        id: ml
+#        uses: megalinter/megalinter@v6
       - name: Archive production artifacts
         if: success() || failure()
         uses: actions/upload-artifact@v3
diff --git a/README.md b/README.md
index cfda7fb47..9e001ebe2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Atala Prism Wallet SDK - Kotlin Multiplatform (Android/JVM/JS/Apple)
+# Atala Prism Wallet SDK - Kotlin Multiplatform (Android/JVM)
 
 [![Kotlin](https://img.shields.io/badge/kotlin-1.7.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
 ![android](https://camo.githubusercontent.com/b1d9ad56ab51c4ad1417e9a5ad2a8fe63bcc4755e584ec7defef83755c23f923/687474703a2f2f696d672e736869656c64732e696f2f62616467652f706c6174666f726d2d616e64726f69642d3645444238442e7376673f7374796c653d666c6174)
@@ -6,9 +6,48 @@
 
 ![Atala Prism Logo](Logo.png)
 
-The wallet SDK will have the following features:
+# Welcome to Atala PRISM Kotlin multiplatform SDK
 
-- Secure Local Storage
-- Key Management
-- DIDComm Operations
-- Transportation Layer by default for sharing the DID using HTTP
+The following will explain how to use the SDK in your project, how to prepare your development environment if you wish to contribute and some basic considerations around the project.
+
+This SDK provides a library and documentation for developers to build Android and JVM connected SSI applications with Atala PRISM.
+
+## Basic considerations
+
+### Atala PRISM
+
+Atala PRISM is a self-sovereign identity (SSI) platform and service suite for verifiable data and digital identity. Built on Cardano, it offers core infrastructure for issuing DIDs (Decentralized identifiers) and verifiable credentials, alongside tools and frameworks to help expand your ecosystem.
+The complete platform is separated in multiple repositories:
+
+<! -- markdown-link-check-disable -->
+* [atala-prism-wallet-sdk-swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo that implements Atala PRISM for Apple platforms in Swift.
+* [atala-prism-wallet-sdk-ts](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) - Repo that implements Atala PRISM for Browser and NodeJS platforms in Typescript.
+* [atala-prism-building-blocks](https://github.com/input-output-hk/atala-prism-building-blocks) - Repo that contains the platform Building Blocks.
+<! -- markdown-link-check-enable -->
+
+### Modules / APIs
+
+Atala PRISM Kotlin multiplatform SDK provides the following building blocks to create, manage and resolve decentralized identifiers, issue, manage and verify verifiable credentials, establish and manage trusted, peer-to-peer connections and interactions between DIDs, and store, manage, and recover verifiable data linked to DIDs.
+
+* __Apollo__: Building block that provides a suite of criptographic operations.
+* __Castor__: Building block that provides a suite of DID operations in a user-controlled manner.
+* __Pollux__: Building block that provides a suite of credential operations in a privacy-preserving manner.
+* __Mercury__: Building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner.
+* __Pluto__: Building block that provides an interface for storage operations in a portable, storage-agnostic manner.
+* __PrismAgent__: PrismAgent using all the building blocks provides a agent that can provide a set of high level DID functionalities.
+
+## Getting started
+
+### Setup
+
+To get started with the Atala PRISM kotlin multiplaform SDK, you can set up the SDK and start a new project or integrate it into an existing project. Before you start, make sure you have the following installed on your development machine:
+
+- Android: API level 21 and above.
+- Kotlin 1.7.20 or later.
+- JVM: 11 or later.
+
+### Integrating the SDK in an existing project
+
+To integrate the SDK into an exiting project, you have to import the SDK into your project:
+
+`implementation("io.iohk.atala.prism:walletsdk:$sdk_version")`