diff --git a/README.md b/README.md index bca2e993..2799b687 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,9 @@ The [`apps/`](./apps) directory contains runnable examples: | [cli_example](./apps/cli_example) | Building a Valdi CLI application | | [benchmark](./apps/benchmark) | Performance benchmarks | -## 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. +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 significant portion of Snap's production apps. ### True Native Performance diff --git a/docs/INSTALL.md b/docs/INSTALL.md index fc465e79..88d3de83 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -12,6 +12,10 @@ This guide will help you set up your development environment and get started wit ### Linux No prerequisites! The Valdi CLI will install everything you need. +> [!IMPORTANT] +> Windows is not currently supported. Please wait for upcoming updates! + + ### All Platforms That's it! The `valdi dev_setup` command handles all other dependencies automatically, including: - Homebrew (macOS) @@ -33,6 +37,10 @@ That's it! The `valdi dev_setup` command handles all other dependencies automati npm install -g @snap/valdi ``` +> [!NOTE] +> During installation, you might see warnings about deprecated packages. These can usually be ignored! + + ### 2. Set Up Your Development Environment ```bash