diff --git a/README.md b/README.md index 6a1d8c5..3596273 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ You should specify settings that will be shared across all the plugin rules. ([M // Attributes/props that could contain Tailwind CSS classes... // Optional, default values: ["class", "className", "ngClass", "@apply"] attributes: ["class"], - // The absolute path pointing to you main Tailwind CSS v4 config file. + // The absolute path pointing to your main Tailwind CSS v4 config file. // It must be a `.css` file (v4), not a `.js` file (v3) // REQUIRED, default value will not help cssConfigPath: dirname(fileURLToPath(import.meta.url)) + "/styles/tailwind.css", @@ -41,7 +41,7 @@ You should specify settings that will be shared across all the plugin rules. ([M The default settings are exported via the [`DEFAULT_SETTINGS`](src/utils/parse-plugin-settings.ts). -## Made fro Tailwind CSS v4 +## Made for Tailwind CSS v4 Version 4 of the `eslint-plugin-tailwindcss` is: @@ -58,7 +58,7 @@ Version 4 of the `eslint-plugin-tailwindcss` is: This branch was started back in 2024, and I was quickly stuck while trying to use the internal mechanics of the `tailwindcss` package. -Simple tasks, like loading the CSS config, was impossible inside an ESLint plugin because ESLint plugins are synchronous by design while the tailwindcss package uses plenty of async functions. +Simple tasks, like loading the CSS config, were impossible inside an ESLint plugin because ESLint plugins are synchronous by design, while the tailwindcss package uses plenty of async functions. 😇 Hopefully, [hyoban](https://github.com/hyoban) made [`tailwind-api-utils`](https://github.com/hyoban/tailwind-api-utils) and [demonstrated in a PR](https://github.com/hyoban/eslint-plugin-tailwindcss/pull/3) how I could use it via [`synckit`](https://www.npmjs.com/package/synckit) 👏. @@ -70,7 +70,7 @@ This version is far from finished, yet it is available and open for contribution - restore the automated tests running on the merge requests of the repo - implement and test the usage of `tailwind-api-utils` -- read the settings from eslint (shared settings & rules settings) +- read the settings from ESLint (shared settings & rules settings) ### Next steps @@ -79,11 +79,11 @@ This version is far from finished, yet it is available and open for contribution ## Contributing -The project is open to all developers, you can [contribute the `eslint-plugin-tailwindcss`](CONTRIBUTING.md). +The project is open to all developers; you can [contribute the `eslint-plugin-tailwindcss`](CONTRIBUTING.md). ## 🤝 Support `eslint-plugin-tailwindcss` -| 🥰 How you can support us? | 💪 They did it! | +| 🥰 How can you support us? | 💪 They did it! | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Premium Sponsors**
Support us by becoming a sponsor.
[Become a recurring sponsor](https://github.com/sponsors/francoismassart?frequency=recurring) | daily.dev Sent.dm | | **Current Sponsors**
Any amount is appreciated. | @kylemh @theMosaad @acewf @dailydotdev @codecov @sourcegraph @getsentry |