summaryrefslogtreecommitdiff
path: root/packages/integrations/react
diff options
context:
space:
mode:
authorGravatar Ben Holmes <hey@bholmes.dev> 2022-03-25 12:15:38 -0400
committerGravatar GitHub <noreply@github.com> 2022-03-25 12:15:38 -0400
commit7c39389a3fa69780ca16bbbf515b5718dd7688d8 (patch)
tree456d0a2387e1153aaa3378e01cd854223beeceb6 /packages/integrations/react
parent4edccae53448b1125e89cdf7ea3389e39af4b5a9 (diff)
downloadastro-7c39389a3fa69780ca16bbbf515b5718dd7688d8.tar.gz
astro-7c39389a3fa69780ca16bbbf515b5718dd7688d8.tar.zst
astro-7c39389a3fa69780ca16bbbf515b5718dd7688d8.zip
Docs: READMEs for component framework integrations (#2880)
* docs: add base integration readme temp for Vue * docs: copy integration temp across renderers * feat: add get started with components section * feat: adapt comp integration docs for lit * nit: THERES TWO WAYS SPECIFICALLY * nit: there's more edits wait "there are" dangit
Diffstat (limited to 'packages/integrations/react')
-rw-r--r--packages/integrations/react/README.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/packages/integrations/react/README.md b/packages/integrations/react/README.md
new file mode 100644
index 000000000..ee2244d44
--- /dev/null
+++ b/packages/integrations/react/README.md
@@ -0,0 +1,65 @@
+# @astrojs/react ⚛️
+
+This **[Astro integration][astro-integration]** enables server-side rendering and client-side hydration for your [React](https://reactjs.org/) components.
+
+## Installation
+
+There are two ways to add integrations to your project. Let's try the most convenient option first!
+
+### (experimental) `astro add` command
+
+Astro includes a CLI tool for adding first party integrations: `astro add`. This command will:
+1. (Optionally) Install all necessary dependencies and peer dependencies
+2. (Also optionally) Update your `astro.config.*` file to apply this integration
+
+To install `@astrojs/react`, run the following from your project directory and follow the prompts:
+
+```sh
+# Using NPM
+npx astro add react
+# Using Yarn
+yarn astro add react
+# Using PNPM
+pnpx 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.
+
+### Install dependencies manually
+
+First, install the `@astrojs/react` integration like so:
+
+```
+npm install @astrojs/react
+```
+
+Most package managers will install associated peer dependencies as well. Still, if you see a "Cannot find package 'react'" (or similar) warning when you start up Astro, you'll need to install `react` and `react-dom`:
+
+```sh
+npm install react react-dom
+```
+
+Now, apply this integration to your `astro.config.*` file using the `integrations` property:
+
+__astro.config.mjs__
+
+```js
+import react from '@astrojs/react';
+
+export default {
+ // ...
+ integrations: [react()],
+}
+```
+
+## Getting started
+
+To use your first React component in Astro, head to our [UI framework documentation][astro-ui-frameworks]. You'll explore:
+- 📦 how framework components are loaded,
+- 💧 client-side hydration options, and
+- 🪆 opportunities to mix and nest frameworks together
+
+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