READMEs docs

[lealobanov]

Description

Update main repo READMEs and add general documentation of SDK functionality.

---

For contributor use:

• [ ] Targeted PR against master branch
• [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• [ ] Code follows the standards mentioned here.
• [ ] Updated relevant documentation
• [ ] Re-reviewed Files changed in the Github PR explorer
• [ ] Added appropriate labels

Summary by CodeRabbit

• Documentation
  • Enhanced and reorganized documentation across multiple README files for improved clarity and usability.
  • Added detailed sections on installation, key generation, account creation, and transaction signing for the Flow JVM SDK.
  • Introduced "Table of Contents" in Java and Kotlin examples for easier navigation.
  • Updated links and corrected typographical errors to enhance accessibility and accuracy.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes encompass textual updates and structural reorganizations across several README files and a Kotlin source file. Enhancements include corrected typographical errors, expanded sections for clarity, and improved navigation features. Notably, the documentation now provides detailed guidance on SDK functionalities, while code examples and integration instructions have been elaborated. The updates aim to enhance usability and accessibility for developers using the Flow JVM SDK.

Changes

Files	Change Summary
README.md, java-example/README.md, kotlin-example/README.md, sdk/README.md	Textual updates, structural reorganization, expanded sections, corrected errors, and improved navigation.
kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getEvent/GetEventAccessAPIConnector.kt	Modified getTransactionResult function for improved readability by integrating API call within the when expression.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlowSDK
    participant FlowEmulator
    participant API

    User->>FlowSDK: Request transaction result
    FlowSDK->>API: Get transaction result by ID
    API-->>FlowSDK: Return transaction result
    FlowSDK-->>User: Provide transaction result

🐰 In the meadow, changes bloom,
With clearer paths, dispelling gloom.
Code examples dance, a joyful sight,
Guiding developers, shining bright!
Hops of progress, leaps of cheer,
Flow SDK's magic, now more clear! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[github-actions[bot]]

SDK Examples Unit Test Results

26 files  ±0  26 suites  ±0   5m 4s :stopwatch: ±0s 59 tests ±0  58 :heavy_check_mark: ±0  0 :zzz: ±0  1 :x: ±0 

For more details on these failures, see this check.

Results for commit d13384bc. ± Comparison against base commit 703ae4a8.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

Common Integration Test Results

0 files  ±0  0 suites  ±0   0s :stopwatch: ±0s 0 tests ±0  0 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit d13384bc. ± Comparison against base commit 703ae4a8.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

Unit Test Results

  53 files  ±0    53 suites  ±0   23s :stopwatch: ±0s 310 tests ±0  310 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit d13384bc. ± Comparison against base commit 703ae4a8.

[github-actions[bot]]

Integration Test Results

  6 files  ±0    6 suites  ±0   2m 34s :stopwatch: ±0s 30 tests ±0  30 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit d13384bc. ± Comparison against base commit 703ae4a8.