Improved README readability #72
Open
samuelgirmametaferia wants to merge 4 commits into
Open
Conversation
Correct capitalization in the description of Valdi.
Added important note about Windows support and installation warnings.
Author
|
I also added a message explaining that windows isn't currently support. In addition during installation via npm you some times see warnings these can be ignored. |
clholgat
reviewed
May 13, 2026
| No prerequisites! The Valdi CLI will install everything you need. | ||
|
|
||
| > [!IMPORTANT] | ||
| > Windows is not currently supported. Please wait for upcoming updates! |
Collaborator
There was a problem hiding this comment.
You can leave this at just "Windows is not currently supported"
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > During installation, you might see warnings about deprecated packages. These can usually be ignored! |
Collaborator
There was a problem hiding this comment.
Suggested change
| > During installation, you might see warnings about deprecated packages. These can usually be ignored! | |
| > During installation, you might see warnings about deprecated packages. These can be ignored! |
| | [benchmark](./apps/benchmark) | Performance benchmarks | | ||
|
|
||
| ## Why Choose Valdi? | ||
| ## Why Valdi? |
| ## Why Choose Valdi? | ||
| ## Why Valdi? | ||
|
|
||
| Valdi is a cross-platform UI framework designed to solve the fundamental problem of cross-platform development: velocity vs. runtime performance. For 8 years, it has powered a large portion of Snap's production apps. |
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
2 participants
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.
I simply improved some of the grammar & wording. Nothing too major!