Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct package name in solid intergration readme #2889

Merged
merged 2 commits into from
Mar 25, 2022
Merged

Correct package name in solid intergration readme #2889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4d8636
Correct package name in solid intergration readme
zadeviggers Mar 25, 2022
803e955
Create polite-mirrors-fix.md
natemoo-re Mar 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/polite-mirrors-fix.md
View file
Open in desktop
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
View file
Open in desktop
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