diff options
| author |  Zade Viggers <74938858+zadeviggers@users.noreply.github.com>
| 2022-03-26 11:54:18 +1300 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-03-25 17:54:18 -0500 |
| commit | 71c12b9047c12158c6e4e67ce0494b8d30ac6387 (patch) | |
| tree | e8dd2d2b4f07ea90d8cc73959d6dda41d4c06d6a | |
| parent | 192d703563506c196c545c05e64493ae96eceb3e (diff) | |
| download | astro-71c12b9047c12158c6e4e67ce0494b8d30ac6387.tar.gz astro-71c12b9047c12158c6e4e67ce0494b8d30ac6387.tar.zst astro-71c12b9047c12158c6e4e67ce0494b8d30ac6387.zip | |
Correct package name in solid intergration readme (#2889)
* Correct package name in solid intergration readme
* Create polite-mirrors-fix.md
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
| -rw-r--r-- | .changeset/polite-mirrors-fix.md | 5 | ||||
| -rw-r--r-- | packages/integrations/solid/README.md | 12 |
2 files changed, 11 insertions, 6 deletions
diff --git a/.changeset/polite-mirrors-fix.md b/.changeset/polite-mirrors-fix.md new file mode 100644 index 000000000..0f4e0a977 --- /dev/null +++ b/.changeset/polite-mirrors-fix.md @@ -0,0 +1,5 @@ +--- +"@astrojs/solid-js": patch +--- + +Correct package name in README. Package is `@astrojs/solid-js`, not `@astrojs/solid`. diff --git a/packages/integrations/solid/README.md b/packages/integrations/solid/README.md index bb8c6b848..ed6d7dc03 100644 --- a/packages/integrations/solid/README.md +++ b/packages/integrations/solid/README.md @@ -1,4 +1,4 @@ -# @astrojs/solid 💙 +# @astrojs/solid-js 💙 This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [SolidJS](https://www.solidjs.com/) components. @@ -12,7 +12,7 @@ Astro includes a CLI tool for adding first party integrations: `astro add`. This 1. (Optionally) Install all necessary dependencies and peer dependencies 2. (Also optionally) Update your `astro.config.*` file to apply this integration -To install `@astrojs/solid`, run the following from your project directory and follow the prompts: +To install `@astrojs/solid-js`, run the following from your project directory and follow the prompts: ```sh # Using NPM @@ -27,10 +27,10 @@ If you run into any hiccups, [feel free to log an issue on our GitHub](https://g ### Install dependencies manually -First, install the `@astrojs/solid` integration like so: +First, install the `@astrojs/solid-js` integration like so: ``` -npm install @astrojs/solid +npm install @astrojs/solid-js ``` Most package managers will install associated peer dependencies as well. Still, if you see a "Cannot find package 'solid-js'" (or similar) warning when you start up Astro, you'll need to install SolidJS: @@ -44,7 +44,7 @@ Now, apply this integration to your `astro.config.*` file using the `integration __astro.config.mjs__ ```js -import solid from '@astrojs/solid'; +import solid from '@astrojs/solid-js'; export default { // ... @@ -62,4 +62,4 @@ To use your first SolidJS component in Astro, head to our [UI framework document Also check our [Astro Integration Documentation][astro-integration] for more on integrations. [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ -[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
\ No newline at end of file +[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components |