Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes and clarifies the project’s README by adding badges, restructuring the configuration section, and updating the Getting Started steps.
- Added Prettier, ESLint, and TypeScript badges
- Moved and expanded environment variable documentation under a new “Configuration” heading
- Updated Getting Started section with separate install and script steps
Comments suppressed due to low confidence (1)
README.md:40
- The command
npm run installis unconventional; the standard usage isnpm install. Either switch tonpm installor ensure there’s aninstallscript defined inpackage.json.
npm run install
| ## Getting Started | ||
|
|
||
| 1. Copy this file to .env and fill in the actual values | ||
| Copy this file to .env and fill in the actual values |
There was a problem hiding this comment.
[nitpick] The Getting Started steps are no longer numbered or bulleted, which may confuse readers. Consider adding numbering or bullet points for consistency.
| ``` | ||
|
|
||
| 1. Run a script: | ||
| Install Dependencies |
There was a problem hiding this comment.
[nitpick] The “Install Dependencies” line isn't formatted as a markdown heading or list item. Consider prefixing it with a heading marker (e.g., ### Install Dependencies) or a bullet for clarity.
Suggested change
| Install Dependencies | |
| ### Install Dependencies |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.