Skip to content

Commit 0efba43

Browse files
committed
📝 Clarify double quotes in README
Clarifies using double quotes for Windows compatibility in README.
1 parent 5c85cb7 commit 0efba43

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,14 @@ npm install --save-dev css-typed
3535
Run `css-typed` and pass it a glob targeting your CSS files.
3636

3737
```shell
38-
npx css-typed 'src/**/*.css'
38+
npx css-typed "src/**/*.css"
3939
```
4040

4141
This will generate `.d.css.ts` files next to the original source files.
4242

43-
> **Note**
43+
See the [run script recipe](#run-script) for adding to your `package.json`.
44+
45+
> [!NOTE]
4446
>
4547
> A CSS module file with the name `foo.module.css` will emit `foo.module.d.css.ts`.
4648
@@ -114,7 +116,7 @@ For example, `my-class` becomes `myClass` and you cannot use `my-class` in JS/TS
114116
Modern bundlers or build system such as Vite and Gatsby support this transformation.
115117
The default matches CSS naming practices (`kebab-case`).
116118

117-
> **IMPORTANT**
119+
> [!IMPORTANT]
118120
>
119121
> Note that `camelCase` and `dashes` MAY have TypeScript bugs.
120122
> TypeScript 5.6 may help with the named exports for these.
@@ -127,18 +129,23 @@ The default matches CSS naming practices (`kebab-case`).
127129

128130
### Run script
129131

130-
To run it as part of your build, you will likely include it as a run script, maybe as `codegen` or `pretsc`.
132+
To run it as part of your build, you will likely include it as a run script, maybe as `codegen`, `css-typed`, or `pretsc`.
131133

132134
```json
133135
{
134136
"scripts": {
135137
"codegen": "css-typed \"src/**/*.css\"",
138+
"css-typed": "css-typed \"src/**/*.css\"",
136139
"pretsc": "css-typed \"src/**/*.css\"",
137140
"tsc": "tsc"
138141
}
139142
}
140143
```
141144

145+
> [!NOTE]
146+
>
147+
> Use `\"` in your run scripts for Windows OS compatibility.
148+
142149
### Watch
143150

144151
The CLI does not have built-in watch support.

0 commit comments

Comments
 (0)