Skip to content

Commit

Permalink
Correct package name in solid intergration readme (#2889)
Browse files Browse the repository at this point in the history
* Correct package name in solid intergration readme

* Create polite-mirrors-fix.md

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
  • Loading branch information
zadeviggers and natemoo-re committed Mar 25, 2022
1 parent 192d703 commit 71c12b9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .changeset/polite-mirrors-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@astrojs/solid-js": patch
---

Correct package name in README. Package is `@astrojs/solid-js`, not `@astrojs/solid`.
12 changes: 6 additions & 6 deletions packages/integrations/solid/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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 {
// ...
Expand All @@ -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

0 comments on commit 71c12b9

Please sign in to comment.