Skip to content

Update readme for react #11

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

Merged
joshsny merged 7 commits into from
Mar 31, 2025
Merged

Update readme for react #11

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b8d443
chore: basic publishing workflow
joshsny Mar 31, 2025
4ea5a8f
chore: add husky
joshsny Mar 31, 2025
0e44b4d
fix: formatting on docs
joshsny Mar 31, 2025
d926bf1
fix: skip install test for now
joshsny Mar 31, 2025
392e53c
fix: linter issues
joshsny Mar 31, 2025
b582e3a
chore: update readme
joshsny Mar 31, 2025
e3980dd
Merge branch 'main' into update-readme-for-react
joshsny Mar 31, 2025
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
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
> **⚠️ Experimental:** This wizard is still in an experimental phase.
> If you have any feedback, please drop an email to **joshua** [at] **posthog** [dot] **com**.

<h1>PostHog Wizard</h1>
<h4>The PostHog Wizard helps you quickly add PostHog to your project.</h4>
<h1>PostHog Wizard ✨</h1>
<h4>The PostHog Wizard helps you quickly add PostHog to your project using AI.</h4>

# Usage

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

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)!
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)!

# Options

The following CLI arguments are available:

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

> 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) 💖
Loading