Update READMEs for Kotlin and Java examples

lealobanov commented 1 month ago

Description

Update READMEs for Kotlin and Java examples.

To-do: Let's add a section below called 'Unsupported features'. We can summarize the missing support for Websockets and Event streaming APIs for now.

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

New Features
- Expanded and restructured documentation for both Java and Kotlin SDK examples.
- Added a comprehensive "Examples summary" section for easy navigation of code examples.
- Updated installation instructions for the Cadence 1.0 CLI.
Bug Fixes
- Enhanced clarity and usability of the README files for better user understanding.
Documentation
- Revised introductions to clarify the purpose of the examples and their usage with the Flow Emulator.
- Improved organization and detail in the usage instructions and example functionalities.
- Introduced a "Table of Contents" for better navigation in the documentation.

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes encompass a comprehensive restructuring and enhancement of the README files for the Java and Kotlin SDK examples. Titles have been updated to reflect a broader scope, and introductions have been clarified regarding the SDK's purpose. Detailed usage instructions have been added, along with a new section summarizing available examples. Additionally, a code refactor in the Kotlin example streamlines a function's implementation without altering its functionality.

Changes

File Path	Change Summary
java-example/README.md	Title updated to "Java Examples." Introduction revised for clarity on SDK usage and Flow Emulator. Detailed usage instructions added. New "Examples summary" section created.
kotlin-example/README.md	Title changed to "Kotlin Examples." Introduction rewritten for clarity on SDK usage and Flow Emulator. Detailed usage instructions added. New "Examples summary" section created.
kotlin-example/src/main/kotlin/.../GetEventAccessAPIConnector.kt	Refactored `getTransactionResult` function for conciseness by integrating response handling within the `when` expression.
sdk/README.md	Section header changed to "Code examples." Clarified installation requirements for Flow CLI and added notes on Cadence 1.0 configuration. Updated references for example tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlowCLI
    participant FlowEmulator
    participant AccessAPI

    User->>FlowCLI: Start Emulator
    FlowCLI->>FlowEmulator: Initialize
    User->>FlowCLI: Run Example
    FlowCLI->>AccessAPI: Get Transaction Result
    AccessAPI-->>FlowCLI: Return Result
    FlowCLI-->>User: Display Result

🐰 "In the meadow, changes bloom,
With examples bright, there's more room!
Java and Kotlin, side by side,
New paths to explore, come take a ride!
With clearer guides, hop along,
In this SDK world, you can't go wrong!" 🐇✨

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] commented 1 month ago

Unit Test Results

  53 files ±0   53 suites ±0 8s :stopwatch: -15s 310 tests ±0 307 :heavy_check_mark: - 3 0 :zzz: ±0 3 :x: +3

For more details on these failures, see this check.

Results for commit cefe072b. ± Comparison against base commit 52724b03.

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

github-actions[bot] commented 1 month ago

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 b4df69c7. ± Comparison against base commit b4df69c7.

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

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

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

For more details on these failures, see this check.

Results for commit 4684515d.

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

github-actions[bot] commented 1 month ago

Common Integration Test Results

1 files +1 1 suites +1 7s :stopwatch: +7s 1 tests +1 1 :heavy_check_mark: +1 0 :zzz: ±0 0 :x: ±0

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

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

onflow / flow-jvm-sdk