Skip to content

Commit 22571d0

Browse files
committed
docs: use giget for single example clone
1 parent 2a57932 commit 22571d0

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@ This repository contains comprehensive examples that demonstrate the Rstack ecos
1717

1818
### Clone single example
1919

20-
To clone a single example, you can use the [gitpick](https://github.com/nrjdalal/gitpick) to clone a sub-directory from the current repository.
20+
To clone a single example, you can use [giget](https://github.com/unjs/giget) to
21+
download a sub-directory from the current repository.
2122

2223
For example, to clone the `/rspack/basic` example, run the following command:
2324

2425
```bash
2526
# Clone the basic example
26-
npx gitpick https://github.com/rstackjs/rstack-examples/tree/main/rspack/basic
27+
npx giget gh:rstackjs/rstack-examples/rspack/basic my-app
2728

2829
# Enter the basic example directory
2930
cd basic
@@ -32,6 +33,19 @@ cd basic
3233
pnpm i
3334
```
3435

36+
The second argument is the output directory. Pass it explicitly so the example is
37+
created with a clear local folder name.
38+
39+
You can clone any other example by replacing the path and output directory:
40+
41+
```bash
42+
# Clone the Rsbuild React example
43+
npx giget gh:rstackjs/rstack-examples/rsbuild/react my-app
44+
45+
# Clone the Rslib React example
46+
npx giget gh:rstackjs/rstack-examples/rslib/react-basic my-lib
47+
```
48+
3549
### Clone all examples
3650

3751
To try all examples, you can clone the current repository to your local.

0 commit comments

Comments
 (0)