Skip to content

Commit 8015842

Browse files
authored
docs: move RTK description in the readme and provide link to RTK
Updated RTK usage instructions and examples in README.
1 parent a893dca commit 8015842

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -128,19 +128,6 @@ corepack enable
128128
corepack prepare pnpm@latest --activate
129129
```
130130

131-
### RTK Usage (Optional but Recommended)
132-
This repository's Copilot instructions prefer using `rtk` (token-optimized CLI proxy) when running terminal commands.
133-
134-
- If `rtk` is installed: prefer `rtk <command>`.
135-
- If `rtk` is not installed: run the raw command directly.
136-
137-
Examples:
138-
```bash
139-
rtk git status
140-
# fallback if rtk is unavailable
141-
git status
142-
```
143-
144131
#### Specific Framework install
145132
For a more targeted install, you could optionally install a specific framework (which avoids installing all frameworks).
146133
You should only do that if you're only interested in contributing something specific to a framework wrapper, see commands below:
@@ -197,6 +184,19 @@ To run all unit tests (with Vitest), you can run one of the following commands (
197184
pnpm run test
198185
```
199186

187+
### [RTK](https://github.com/rtk-ai/rtk) Usage (Optional but Recommended)
188+
This repository's Copilot instructions prefer using [`rtk`](https://github.com/rtk-ai/rtk) (token-optimized CLI proxy) when running terminal commands.
189+
190+
- If `rtk` is installed: prefer `rtk <command>`.
191+
- If `rtk` is not installed: run the raw command directly.
192+
193+
Examples:
194+
```bash
195+
rtk git status
196+
# fallback if rtk is unavailable
197+
git status
198+
```
199+
200200
#### [Cypress](https://cypress.io/) E2E Tests
201201
To run all E2E tests (with Cypress), you can run one of the following commands (make sure that steps 1-2 were executed prior to running this command)
202202

0 commit comments

Comments
 (0)