Skip to content

Commit 4ffad1f

Browse files
authored
Update readme for react (#11)
* chore: basic publishing workflow * chore: add husky * fix: formatting on docs * fix: skip install test for now * fix: linter issues * chore: update readme
1 parent 83c2d37 commit 4ffad1f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
> **⚠️ Experimental:** This wizard is still in an experimental phase.
66
> If you have any feedback, please drop an email to **joshua** [at] **posthog** [dot] **com**.
77
8-
<h1>PostHog Wizard</h1>
9-
<h4>The PostHog Wizard helps you quickly add PostHog to your project.</h4>
8+
<h1>PostHog Wizard</h1>
9+
<h4>The PostHog Wizard helps you quickly add PostHog to your project using AI.</h4>
1010

1111
# Usage
1212

@@ -16,21 +16,21 @@ To use the wizard, you can run it directly using:
1616
npx @posthog/wizard
1717
```
1818

19-
Currently the wizard can be used for Next.js only. If you have other platforms you would like the wizard to support, please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
19+
Currently the wizard can be used for React & Next.js projects. If you have other integrations you would like the wizard to support, please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
2020

2121
# Options
2222

2323
The following CLI arguments are available:
2424

25-
| Option | Description | Type | Default | Choices | Environment Variable |
26-
| ----------------- | -------------------------------------------------------------------------- | ------- | ------------------------------- | ---------- | ---------------------------- |
27-
| `--help` | Show help | boolean | | | |
28-
| `--version` | Show version number | boolean | | | |
29-
| `--debug` | Enable verbose logging | boolean | `false` | | `POSTHOG_WIZARD_DEBUG` |
30-
| `--integration` | Choose the integration to setup | choices | Select integration during setup | "nextjs" | `POSTHOG_WIZARD_INTEGRATION` |
31-
| `--force-install` | Force install the SDK NPM package (use with caution!) | boolean | `false` | | |
32-
| `--install-dir` | Relative path to install in | string | `.` | | `POSTHOG_WIZARD_INSTALL_DIR` |
33-
| `--region` | PostHog region to use | choices | | "us", "eu" | `POSTHOG_WIZARD_REGION` |
34-
| `--default` | Select the default option for all questions automatically (where possible) | boolean | `false` | | `POSTHOG_WIZARD_DEFAULT` |
25+
| Option | Description | Type | Default | Choices | Environment Variable |
26+
| ----------------- | -------------------------------------------------------------------------- | ------- | ------------------------------- | ----------------- | ---------------------------- |
27+
| `--help` | Show help | boolean | | | |
28+
| `--version` | Show version number | boolean | | | |
29+
| `--debug` | Enable verbose logging | boolean | `false` | | `POSTHOG_WIZARD_DEBUG` |
30+
| `--integration` | Choose the integration to setup | choices | Select integration during setup | "nextjs", "react" | `POSTHOG_WIZARD_INTEGRATION` |
31+
| `--force-install` | Force install the SDK NPM package (use with caution!) | boolean | `false` | | |
32+
| `--install-dir` | Relative path to install in | string | `.` | | `POSTHOG_WIZARD_INSTALL_DIR` |
33+
| `--region` | PostHog region to use | choices | | "us", "eu" | `POSTHOG_WIZARD_REGION` |
34+
| `--default` | Select the default option for all questions automatically (where possible) | boolean | `false` | | `POSTHOG_WIZARD_DEFAULT` |
3535

3636
> Note: A large amount of the scaffolding for this came from the amazing Sentry wizard, which you can find [here](https://github.com/getsentry/sentry-wizard) 💖

0 commit comments

Comments
 (0)