From 93fe558f818e70b8c4de4549eec28daca58bded5 Mon Sep 17 00:00:00 2001 From: Lea Lobanov Date: Wed, 17 Jul 2024 17:18:23 +1000 Subject: [PATCH] Updating documentation --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 564d658..1707ae2 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,17 @@ At the moment, this SDK includes the following features: ## Repository modules +This repository is organized as a multi-module project, consisting of the following modules: + +### SDK +The core module that includes all the necessary tools and libraries to interact with the Flow blockchain. This module provides the main functionalities such as transaction preparation, signing, and interaction with the Flow Access API. + +### Java Example +This module contains example implementations demonstrating how to use the Flow JVM SDK in a Java application. It includes sample code for various use cases, making it easier for developers to understand and integrate the SDK into their Java projects. + +### Kotlin Example +Similar to the Java Example module, this module provides sample implementations in Kotlin. It showcases how to leverage the SDK's capabilities in a Kotlin environment. + ## Contribute to this SDK This project is in the very early phase; all contributions are welcomed.