Skip to content

[draft] feat(docs): add qwik-cli integration as the preferred way to setup #10

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ src="https://raw.githubusercontent.com/ianlet/qwik-testing-library/main/high-vol

- [The Problem](#the-problem)
- [This Solution](#this-solution)
- [Installation](#installation)
- [Setup](#setup)
- [Qwik CLI (preferred)](#qwik-cli-preferred)
- [Manual Installation](#manual-installation)
- [Examples](#examples)
- [Qwikstart](#qwikstart)
- [Mocking Component Callbacks (experimental)](#mocking-component-callbacks-experimental)
Expand Down Expand Up @@ -122,7 +123,23 @@ rendered output in the DOM. Its primary guiding principle is:

[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106

## Installation
## Setup

### Qwik CLI (preferred)

For the best experience, you can use the [Qwik CLI][qwik-cli] to install this library.
It takes care of configuring your project for you and adding all the required dependencies.
It will also add an example on how to test your Qwik components with `qwik-testing-library`.

```shell
pnpm qwik add testing-library
```

If you prefer to do it yourself, or are curious about what the command above will do for you, follow along.

[qwik-cli]: https://qwik.dev/docs/integrations/testing-library/

### Manual Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `devDependencies`:
Expand Down
Loading