Update README.md #30
Update README.md #30
Conversation
WalkthroughThe update involves a simplification of the documentation, specifically within the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 29
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (1 hunks)
Additional comments: 1
README.md (1)
- 101-106: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [74-74]
The repeated word "do-it" in the command usage example might be a typo. Please verify if this repetition is intentional.
|
|
||
| <!-- TODO: add how to check for the packet on explorer or set up an event listener --> | ||
|
|
||
| Check if the packet got through on the [Polymer IBC explorer](https://explorer.prod.testnet.polymer.zone/packets). | ||
|
|
||
| ## 💻 Develop your custom application | ||
|
|
||
| The main work for you as a developer is to develop the contracts that make up your cross-chain logic. |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]
Consider revising "rollups to one another Polymer Hub" to "rollups to the Polymer Hub" for clarity and to correct the possible spelling mistake.
- rollups to one another Polymer Hub
+ rollups to the Polymer Hub📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [5-5]
A comma might enhance readability after "repository" in the sentence starting with "The repository is a GitHub template repository".
- The repository is a _GitHub template_ repository
+ The repository is a _GitHub template_ repository,📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [11-11]
Consider adding a comma before "but" to connect two independent clauses for improved readability.
- There's some basic information here in the README but a more comprehensive documentation can
+ There's some basic information here in the README, but a more comprehensive documentation can📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [19-19]
The abbreviation "npm" is more commonly used in lowercase. Consider revising for consistency with common practices.
- (Hardhat will be installed when running `npm install`)
+ (Hardhat will be installed when running `npm install`)📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [23-23]
The term "third party's" seems to be incorrectly used. If referring to multiple third parties, consider revising to "third parties'".
- You'll need some API keys from third party's:
+ You'll need some API keys from third parties':📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [32-32]
A comma after "directory" could improve the flow of the sentence.
- From the root directory run:
+ From the root directory, run:📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [37-37]
The sentence starting with "to install the [vIBC core smart contracts]" should begin with an uppercase letter for consistency.
- to install the [vIBC core smart contracts]
+ To install the [vIBC core smart contracts]📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [39-39]
Consider adding a comma after "Additionally" for clarity.
- Additionally Hardhat will be installed as a dev dependency
+ Additionally, Hardhat will be installed as a dev dependency📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [44-44]
A comma after "commits" could improve the readability of the sentence.
- This will ignore the file for future git commits as well as expose the environment variables
+ This will ignore the file for future git commits, as well as expose the environment variables📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [50-50]
The term "justfile" is typically written as "Justfile". Consider revising for consistency with common naming conventions.
- the scripts from the justfile will fail.
+ the scripts from the Justfile will fail.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [59-59]
Consider revising "Quickstart" to "Quick Start" for consistency with common terminology.
- ## 🏃🏽🏃🏻♀️ Quickstart
+ ## 🏃🏽🏃🏻♀️ Quick Start📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [65-65]
The file extension ".json" in "config.json" is typically written in lowercase. Consider revising for consistency.
- The default setup (`.env`, `config.json`)
+ The default setup (`.env`, `config.json`)📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [89-89]
Consider adding a comma before "BUT" for clarity and grammatical correctness.
- useful for iterative development and testing BUT also insecure
+ useful for iterative development and testing, BUT also insecure📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [114-114]
The term "Justfile" is typically capitalized. Consider revising for consistency with common naming conventions.
- There is a Justfile to for the most common commands
+ There is a Justfile for the most common commands📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [115-115]
Consider revising "There's three types" to "There are three types" for grammatical correctness.
- There's three types of default scripts in the project:
+ There are three types of default scripts in the project:📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [122-122]
A comma after "script" could improve the readability of the sentence.
- For every script you'll find a field in the configuration file
+ For every script, you'll find a field in the configuration file📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [124-124]
Consider adding a comma after "cases" for clarity.
- For more complicated use cases you will want to customize the scripts
+ For more complicated use cases, you will want to customize the scripts📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [136-136]
The sentence starting with "to deploy MyContract artefact" should begin with an uppercase letter for consistency.
- to deploy _MyContract_ artefact to the Optimism (Sepolia) chain.
+ To deploy _MyContract_ artefact to the Optimism (Sepolia) chain.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [137-137]
Consider revising "artefact" to "artifact" for American English consistency.
- to deploy _MyContract_ artefact to the Optimism (Sepolia) chain.
+ to deploy _MyContract_ artifact to the Optimism (Sepolia) chain.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [152-152]
The sentence starting with "for an application that uses custom channels" should begin with an uppercase letter for consistency.
- for an application that uses custom channels.
+ For an application that uses custom channels.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [168-168]
A comma after "contract" could improve the readability of the sentence.
- Your contract will send and receive packet data from the Universal channel handler contract
+ Your contract will send and receive packet data from the Universal channel handler contract,📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [190-190]
The sentence starting with "to send a packet over a universal channel" should begin with an uppercase letter for consistency.
- to send a packet over a **universal channel**.
+ To send a packet over a **universal channel**.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [198-198]
The sentence starting with "to send a packet over a custom channel" should begin with an uppercase letter for consistency.
- to send a packet over a **custom channel**.
+ To send a packet over a **custom channel**.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [203-203]
Consider adding a comma before "BUT" for clarity and grammatical correctness.
- useful for iterative development and testing BUT also insecure
+ useful for iterative development and testing, BUT also insecure📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [214-214]
Consider revising "custimizations" to "customizations" for spelling accuracy and "These includes" to "These include" for grammatical correctness.
- there's multiple custimizations to follow. These includes configuring
+ there are multiple customizations to follow. These include configuring📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [228-228]
Consider adding a comma before "so" for clarity and grammatical correctness.
- Assign yourself to the issue so people know you're working on it.
+ Assign yourself to the issue, so people know you're working on it.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [229-229]
Consider adding a comma after "Alternatively" for clarity.
- Alternatively you can open an issue for a new idea or piece of feedback.
+ Alternatively, you can open an issue for a new idea or piece of feedback.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [236-236]
Consider adding a comma before "and" for clarity and grammatical correctness.
- submit a PR to the repo and we'll review as soon as possible.
+ submit a PR to the repo, and we'll review as soon as possible.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [239-239]
Consider using a less frequent alternative to "Feel free to" for a more professional tone.
- Feel free to open an issue for questions, suggestions, or discussions related to this repository.
+ You are welcome to open an issue for questions, suggestions, or discussions related to this repository.
Summary by CodeRabbit