diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index c41ddfa8e..d57f308b8 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -10,6 +10,7 @@
"mikestead.dotenv",
"streetsidesoftware.code-spell-checker",
"vscode-icons-team.vscode-icons",
- "zixuanchen.vitest-explorer"
+ "zixuanchen.vitest-explorer",
+ "stateful.runme"
]
}
diff --git a/README.md b/README.md
index 35a2c65c2..59ec53cce 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@
+
The web's most popular Jamstack front-end template for building web applications with
[React](https://react.dev/).
@@ -52,19 +53,26 @@ Be sure to join our [Discord channel](https://discord.com/invite/2nKEnKq) for as
## Getting Started
-[Generate](https://github.com/kriasoft/react-starter-kit/generate) a new project
-from this template, clone it, install project dependencies, update the
-environment variables found in [`env/*.env`](./env/), and start hacking:
+[Generate](https://github.com/kriasoft/react-starter-kit/generate) a new project from this template by clicking [this link](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fkriasoft%2Freact-starter-kit.git&fileToOpen=README.md) if you are a VS Code user or manually clone it via:
-```
+```bash
$ git clone https://github.com/kriasoft/react-starter-kit.git example
$ cd ./example
+```
+
+Then install project dependencies, update the environment variables found in [`env/*.env`](./env/), and start hacking:
+
+```bash
$ yarn install
$ yarn start
```
The app will become available at [http://localhost:5173/](http://localhost:5173/) (press `q` key to exit).
+```bash
+open http://localhost:5173/
+```
+
**IMPORTANT**: Ensure that VSCode is using the workspace [version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-newer-typescript-versions)
and ESLint.