Skip to content

Commit 6b4659e

Browse files
committed
chore: update readme
1 parent 04ffad4 commit 6b4659e

File tree

2 files changed

+23
-31
lines changed

2 files changed

+23
-31
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,22 @@ pnpm add -D tailwindcss @leedomjs/tailwindcss-preset
1616

1717
### Config `tailwind.config.js`
1818

19-
```js
20-
/** @type {import('tailwindcss').Config} */
19+
> There is an object param that contains some fields `mp`, `element`, `naive`, `vant`.
20+
>
21+
> `mp` defaults to `false`, setting `mp` be `true` will enable the preset,
22+
> otherwise will enable default config of tailwindcss and disable the preset meanwhile.
23+
>
24+
> `element`, `naive`, `vant`, these params default to dependencies that your project uses.
25+
>
26+
> If your project depends on `element-ui`, `element-plus`, `naive-ui`, `vant-ui`,the color will be enable automatically. Setting to false will disable the color, otherwise will enabled.
2127
22-
const preset = require('@leedomjs/tailwindcss-preset')
28+
```js
29+
const leedom = require('@leedomjs/tailwindcss-preset')
2330

31+
/** @type {import('tailwindcss').Config} */
2432
module.exports = {
2533
presets: [
26-
/**
27-
* There is an object param that contains some fields `mp`, `element`, `naive`, `vant`.
28-
*
29-
* `mp` defaults to `false`, setting `mp` be `true` will enable the preset,
30-
* otherwise will enable default config of tailwindcss and disable the preset meanwhile.
31-
*
32-
* `element`, `naive`, `vant`, these params default to dependencies that your project uses.
33-
* If your project depends on `element-ui`, `element-plus`, `naive-ui`, `vant-ui`,
34-
* the color will be enable automatically.
35-
* Setting to false will disable the color, otherwise will enabled.
36-
*
37-
*
38-
*/
39-
preset({
34+
leedom({
4035
mp: true,
4136
element: true,
4237
naive: true,

packages/tailwindcss-preset/README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,22 @@ pnpm add -D tailwindcss @leedomjs/tailwindcss-preset
1616

1717
### Config `tailwind.config.js`
1818

19-
```js
20-
/** @type {import('tailwindcss').Config} */
19+
> There is an object param that contains some fields `mp`, `element`, `naive`, `vant`.
20+
>
21+
> `mp` defaults to `false`, setting `mp` be `true` will enable the preset,
22+
> otherwise will enable default config of tailwindcss and disable the preset meanwhile.
23+
>
24+
> `element`, `naive`, `vant`, these params default to dependencies that your project uses.
25+
>
26+
> If your project depends on `element-ui`, `element-plus`, `naive-ui`, `vant-ui`,the color will be enable automatically. Setting to false will disable the color, otherwise will enabled.
27+
2128

29+
```js
2230
const leedom = require('@leedomjs/tailwindcss-preset')
2331

32+
/** @type {import('tailwindcss').Config} */
2433
module.exports = {
2534
presets: [
26-
/**
27-
* There is an object param that contains some fields `mp`, `element`, `naive`, `vant`.
28-
*
29-
* `mp` defaults to `false`, setting `mp` be `true` will enable the preset,
30-
* otherwise will enable default config of tailwindcss and disable the preset meanwhile.
31-
*
32-
* `element`, `naive`, `vant`, these params default to dependencies that your project uses.
33-
* If your project depends on `element-ui`, `element-plus`, `naive-ui`, `vant-ui`,
34-
* the color will be enable automatically.
35-
* Setting to false will disable the color, otherwise will enabled.
36-
*
37-
*/
3835
leedom({
3936
mp: true,
4037
element: true,

0 commit comments

Comments
 (0)