docs: update README - #28
Conversation
There was a problem hiding this comment.
Pull Request Overview
Updates the README.md documentation to improve clarity and user experience by adding Node.js version requirements, restructuring usage examples, and including demo images.
- Adds Node.js ≥18 requirement with badge and dedicated section
- Restructures usage examples with separate code blocks and demo images
- Removes detailed development section and updates license link
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -1,11 +1,17 @@ | |||
| # envui | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
[nitpick] The HTML entity '%E2%89%A5' for the ≥ symbol in the badge URL should be URL-encoded as '%E2%89%A5' or use the literal character '≥'. However, the current encoding appears correct - this may render properly as intended.
|  | |
|  |
|
|
||
| Demo output: | ||
|
|
||
|  |
There was a problem hiding this comment.
The demo images reference local asset files that may not exist in the repository. Consider verifying these image files are included in the PR or use alternative hosting for the demo images.
|
|
||
| Demo output: | ||
|
|
||
|  |
There was a problem hiding this comment.
The demo images reference local asset files that may not exist in the repository. Consider verifying these image files are included in the PR or use alternative hosting for the demo images.
No description provided.