search

kroma-network / kroma

A developer-friendly, rollup-based Ethereum Layer 2 solution that offers low fees and EVM equivalence.
Other
153 stars 77 forks source link

Update README.md #310

Closed buketgul23 closed 2 months ago

buketgul23 commented 2 months ago

Description

First of all, thank you for your contributions!

Here, you need to describe all the changes in this PR clearly and concisely.

Fixes #ISSUE_NUMBER

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent update involves significant removals from the README.md file, specifically deleting all external links associated with the Kroma project. These include links to its website, documentation, blog, and social media platforms like Discord and Twitter. Moreover, the section detailing the security policy, along with its reference link, has also been eliminated.

Changes

File Change Summary
README.md Removed links to official website, documentation, blog, Discord, and Twitter. Removed security policy section and its reference link.
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 15d9effb2e9be78f26973f9c9a86cb2cfddd3501 and 78c0fed12d6b8fb768158c7938d6c7eb21aba32f.
Files selected for processing (1) * README.md (2 hunks)
Additional Context Used
LanguageTool (25)
README.md (25)
Near line 10: Possible spelling mistake found. Context: ...thereum.
## About Kroma Kroma is the first universal stage 2 L... --- Near line 11: Possible spelling mistake found. Context: ....
## About Kroma Kroma is the first universal stage 2 Layer 2 ... --- Near line 12: Possible spelling mistake found. Context: ...ersal stage 2 Layer 2 (L2) on Ethereum. Kroma has been developed based on Optimism Be... --- Near line 13: Possible spelling mistake found. Context: ...rchitecture, and aims to be a universal ZK rollup. Currently, Kroma operates as an... --- Near line 13: Possible spelling mistake found. Context: ...itecture, and aims to be a universal ZK rollup. Currently, Kroma operates as an Optimi... --- Near line 13: Possible spelling mistake found. Context: ...to be a universal ZK rollup. Currently, Kroma operates as an Optimistic rollup with Z... --- Near line 13: Possible spelling mistake found. Context: ...rently, Kroma operates as an Optimistic rollup with ZK fault proofs, utilizing a zkEVM... --- Near line 13: Possible spelling mistake found. Context: ...a operates as an Optimistic rollup with ZK fault proofs, utilizing a zkEVM based o... --- Near line 14: Possible spelling mistake found. Context: ...ollup with ZK fault proofs, utilizing a zkEVM based on Scroll. The goal of Kroma is t... --- Near line 14: Only proper nouns start with an uppercase character (there are exceptions for headlines). Context: ...ault proofs, utilizing a zkEVM based on Scroll. The goal of Kroma is to eventually tra... --- Near line 14: Possible spelling mistake found. Context: ...ng a zkEVM based on Scroll. The goal of Kroma is to eventually transition to a ZK rol... --- Near line 14: Possible spelling mistake found. Context: ... Kroma is to eventually transition to a ZK rollup once the generation of ZK proofs... --- Near line 14: Possible spelling mistake found. Context: ...oma is to eventually transition to a ZK rollup once the generation of ZK proofs become... --- Near line 15: Possible spelling mistake found. Context: ...n to a ZK rollup once the generation of ZK proofs becomes more cost-efficient and ... --- Near line 16: Possible spelling mistake found. Context: ...ecomes more cost-efficient and faster. Kroma offers lower transactions fees compared... --- Near line 17: Possible spelling mistake found. Context: ...nsactions fees compared to the Ethereum mainnet, with native Ethereum security and EVM ... --- Near line 18: Possible spelling mistake found. Context: ...r roadmap to transition from Optimistic rollup to ZK rollup sets Kroma apart from othe... --- Near line 18: Possible spelling mistake found. Context: ...to transition from Optimistic rollup to ZK rollup sets Kroma apart from other L2 n... --- Near line 18: Possible spelling mistake found. Context: ...transition from Optimistic rollup to ZK rollup sets Kroma apart from other L2 networks... --- Near line 18: Possible spelling mistake found. Context: ...rom Optimistic rollup to ZK rollup sets Kroma apart from other L2 networks. Additiona... --- Near line 19: Possible spelling mistake found. Context: ...t from other L2 networks. Additionally, Kroma is advancing towards decentralization. ... --- Near line 19: Possible spelling mistake found. Context: ...alization. As an initial step for this, Kroma has introduced a permissionless validat... --- Near line 22: Possible spelling mistake found. Context: ...m. For more detailed information about Kroma, check [Kroma docs](https://docs.kroma.... --- Near line 22: Possible spelling mistake found. Context: ...etailed information about Kroma, check [Kroma docs](https://docs.kroma.network) (or [... --- Near line 31: Possible spelling mistake found. Context: ...ironment set up to start working on the Kroma repository. Then check out our list of ...
Additional comments not posted (1)
README.md (1)
`32-37`: > :memo: **NOTE** > This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [31-35] Reduce consecutive blank lines to improve readability and adhere to best practices. ```diff - - - + ```
--- 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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.
Pangssu commented 2 months ago

Why did you delete them?