michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Correct package name in solid intergration readme (#2889)

Browse source 
* Correct package name in solid intergration readme

* Create polite-mirrors-fix.md

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
This commit is contained in:
Zade Viggers 2022-03-26 11:54:18 +13:00 committed by GitHub
parent 192d703563
commit 71c12b9047
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/polite-mirrors-fix.md Normal file
View file

@ -0,0 +1,5 @@
---
"@astrojs/solid-js": patch
---
Correct package name in README. Package is `@astrojs/solid-js`, not `@astrojs/solid`.

12
packages/integrations/solid/README.md
View file

@ -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
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components