Skip to content

Commit

Permalink
docs: add hot to use to README (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored May 19, 2024
1 parent eed441c commit 6892f37
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,35 @@

This repository is intended to showcase examples of Rspack related stuff, such as Rspack, Rsbuild, Rspress and Rsdoctor.

| [Rspack](https://github.com/web-infra-dev/rspack) | <a href="https://github.com/web-infra-dev/rspack" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/02ac97ba-b722-4047-aa74-85c2509bf6e9" width="400" /></a> | [Examples](./rspack) |
| :---------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------: |
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | <a href="https://github.com/web-infra-dev/rsbuild" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/a74669c9-3e73-4bad-9ea4-dbe89284849a" width="400" /></a> | [Examples](./rsbuild) |
| [Rspress](https://github.com/web-infra-dev/rspress) | <a href="https://github.com/web-infra-dev/rspress" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/aa0c19ba-b2c7-4b44-85ab-54c7ef35f914" width="400" /></a> | [Examples](./rspress/) |
## List of Examples

| [Rspack](https://github.com/web-infra-dev/rspack) | <a href="https://github.com/web-infra-dev/rspack" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/02ac97ba-b722-4047-aa74-85c2509bf6e9" width="400" /></a> | [Examples](./rspack) |
| :---------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------: |
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | <a href="https://github.com/web-infra-dev/rsbuild" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/a74669c9-3e73-4bad-9ea4-dbe89284849a" width="400" /></a> | [Examples](./rsbuild) |
| [Rspress](https://github.com/web-infra-dev/rspress) | <a href="https://github.com/web-infra-dev/rspress" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/aa0c19ba-b2c7-4b44-85ab-54c7ef35f914" width="400" /></a> | [Examples](./rspress/) |
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | <a href="https://github.com/web-infra-dev/rsdoctor" target="blank"><img src="https://github.com/web-infra-dev/.github/assets/7237365/8131f196-f034-43a1-be8d-38ee7994792e" width="400" /></a> | [Examples](./rsdoctor/) |

## How to Use

1. First, clone the current repository to your local:

```bash
git clone [email protected]:rspack-contrib/rspack-examples.git
```

2. Then, choose the example you need, such as the Rsbuild react example:

```bash
cd rsbuild/react
```

3. Install the dependencies using `pnpm` or other package manager, then start the project:

```bash
# Use corepack to enable pnpm
corepack enable
pnpm i
pnpm run dev
```

4. You can fork the current project or copy the code from the current project to use it.

0 comments on commit 6892f37

Please sign in to comment.