From d693e365ca1b281b227b54485fd672e2107bec72 Mon Sep 17 00:00:00 2001 From: Tibor Schiemann <6137925+hippotastic@users.noreply.github.com> Date: Wed, 7 Sep 2022 12:08:58 +0200 Subject: [PATCH] Integrations: Fix NPM instructions to use `npx astro add` again (#4653) * Fix install instructions to use `npx astro` again * Replace joyful hiccups with regular issues :) --- packages/integrations/alpinejs/README.md | 6 ++++-- packages/integrations/image/README.md | 8 ++++---- packages/integrations/lit/README.md | 6 ++++-- packages/integrations/mdx/README.md | 6 +++--- packages/integrations/partytown/README.md | 8 ++++---- packages/integrations/preact/README.md | 6 +++--- packages/integrations/prefetch/README.md | 8 ++++---- packages/integrations/react/README.md | 6 ++++-- packages/integrations/sitemap/README.md | 8 ++++---- packages/integrations/solid/README.md | 6 ++++-- packages/integrations/svelte/README.md | 6 ++++-- packages/integrations/tailwind/README.md | 8 ++++---- packages/integrations/turbolinks/README.md | 6 ++++-- packages/integrations/vue/README.md | 6 ++++-- 14 files changed, 54 insertions(+), 40 deletions(-) diff --git a/packages/integrations/alpinejs/README.md b/packages/integrations/alpinejs/README.md index 3d43b3e25..9eaf45382 100644 --- a/packages/integrations/alpinejs/README.md +++ b/packages/integrations/alpinejs/README.md @@ -18,14 +18,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add alpinejs +npx astro add alpinejs # Using Yarn yarn astro add alpinejs # Using PNPM pnpm astro add alpinejs ``` -Finally, in the terminal window running Astro, press `CTRL+C` and then type `npm run astro dev` to restart the dev server. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/image/README.md b/packages/integrations/image/README.md index 394db59de..2ecc81364 100644 --- a/packages/integrations/image/README.md +++ b/packages/integrations/image/README.md @@ -29,16 +29,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add image +npx astro add image # Using Yarn yarn astro add image # Using PNPM pnpm astro add image ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. - -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/lit/README.md b/packages/integrations/lit/README.md index 50b9c34fc..97b836bc0 100644 --- a/packages/integrations/lit/README.md +++ b/packages/integrations/lit/README.md @@ -16,14 +16,16 @@ To install `@astrojs/lit`, run the following from your project directory and fol ```sh # Using NPM -npm run astro add lit +npx astro add lit # Using Yarn yarn astro add lit # Using PNPM pnpm astro add lit ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md index e559223d5..2ce12d9cd 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -26,16 +26,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add mdx +npx astro add mdx # Using Yarn yarn astro add mdx # Using PNPM pnpm astro add mdx ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/partytown/README.md b/packages/integrations/partytown/README.md index b89538bd9..6ff8dd200 100644 --- a/packages/integrations/partytown/README.md +++ b/packages/integrations/partytown/README.md @@ -28,16 +28,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add partytown +npx astro add partytown # Using Yarn yarn astro add partytown # Using PNPM pnpm astro add partytown ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. - -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/preact/README.md b/packages/integrations/preact/README.md index bca45007d..2a8779737 100644 --- a/packages/integrations/preact/README.md +++ b/packages/integrations/preact/README.md @@ -28,16 +28,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add preact +npx astro add preact # Using Yarn yarn astro add preact # Using PNPM pnpm astro add preact ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/prefetch/README.md b/packages/integrations/prefetch/README.md index c1299cf5a..e3ae6e72a 100644 --- a/packages/integrations/prefetch/README.md +++ b/packages/integrations/prefetch/README.md @@ -22,16 +22,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add prefetch +npx astro add prefetch # Using Yarn yarn astro add prefetch # Using PNPM pnpm astro add prefetch ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. - -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/react/README.md b/packages/integrations/react/README.md index cda193b9f..1e502b6c0 100644 --- a/packages/integrations/react/README.md +++ b/packages/integrations/react/README.md @@ -16,14 +16,16 @@ To install `@astrojs/react`, run the following from your project directory and f ```sh # Using NPM -npm run astro add react +npx astro add react # Using Yarn yarn astro add react # Using PNPM pnpm astro add react ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually diff --git a/packages/integrations/sitemap/README.md b/packages/integrations/sitemap/README.md index 8482225a3..58a3cc1d6 100644 --- a/packages/integrations/sitemap/README.md +++ b/packages/integrations/sitemap/README.md @@ -28,16 +28,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add sitemap +npx astro add sitemap # Using Yarn yarn astro add sitemap # Using PNPM pnpm astro add sitemap ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. - -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/solid/README.md b/packages/integrations/solid/README.md index fb700117c..5afe62c11 100644 --- a/packages/integrations/solid/README.md +++ b/packages/integrations/solid/README.md @@ -16,14 +16,16 @@ To install `@astrojs/solid-js`, run the following from your project directory an ```sh # Using NPM -npm run astro add solid +npx astro add solid # Using Yarn yarn astro add solid # Using PNPM pnpm astro add solid ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually diff --git a/packages/integrations/svelte/README.md b/packages/integrations/svelte/README.md index 0bc5ebdd1..8acd41a6f 100644 --- a/packages/integrations/svelte/README.md +++ b/packages/integrations/svelte/README.md @@ -16,14 +16,16 @@ To install `@astrojs/svelte`, run the following from your project directory and ```sh # Using NPM -npm run astro add svelte +npx astro add svelte # Using Yarn yarn astro add svelte # Using PNPM pnpm astro add svelte ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually diff --git a/packages/integrations/tailwind/README.md b/packages/integrations/tailwind/README.md index fb6a5ec76..df1002038 100644 --- a/packages/integrations/tailwind/README.md +++ b/packages/integrations/tailwind/README.md @@ -31,16 +31,16 @@ The `astro add` command-line tool automates the installation for you. Run one of ```sh # Using NPM -npm run astro add tailwind +npx astro add tailwind # Using Yarn yarn astro add tailwind # Using PNPM pnpm astro add tailwind ``` -Then, restart the dev server by typing `CTRL-C` and then `npm run astro dev` in the terminal window that was running Astro. - -Because this command is new, it might not properly set things up. If that happens, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Manual Install diff --git a/packages/integrations/turbolinks/README.md b/packages/integrations/turbolinks/README.md index 8c14dd2f6..15ece4721 100644 --- a/packages/integrations/turbolinks/README.md +++ b/packages/integrations/turbolinks/README.md @@ -26,14 +26,16 @@ To install `@astrojs/turbolinks`, run the following from your project directory ```sh # Using NPM -npm run astro add turbolinks +npx astro add turbolinks # Using Yarn yarn astro add turbolinks # Using PNPM pnpm astro add turbolinks ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually diff --git a/packages/integrations/vue/README.md b/packages/integrations/vue/README.md index c5fa4a536..66b320629 100644 --- a/packages/integrations/vue/README.md +++ b/packages/integrations/vue/README.md @@ -16,14 +16,16 @@ To install `@astrojs/vue`, run the following from your project directory and fol ```sh # Using NPM -npm run astro add vue +npx astro add vue # Using Yarn yarn astro add vue # Using PNPM pnpm astro add vue ``` -If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. +Finally, in the terminal window running Astro, press `CTRL+C` and then restart the dev server. + +If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below. ### Install dependencies manually