Skip to content

docs: fix typos and enhance clarity in README.md #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: alpha/v4
Choose a base branch
from
+6 −6
Open

docs: fix typos and enhance clarity in README.md #430

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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:

Expand All @@ -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) 👏.

Expand All @@ -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

Expand All @@ -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** <br /> Support us by becoming a sponsor. <br /> [Become a recurring sponsor](https://github.com/sponsors/francoismassart?frequency=recurring) | <a href="https://daily.dev/" target="_blank"><img alt="daily.dev" width="150" src="https://raw.githubusercontent.com/francoismassart/eslint-plugin-tailwindcss/master/sponsors/daily.dev.jpg"></a> <a href="https://www.sent.dm/" target="_blank"><img alt="Sent.dm" width="150" src="https://avatars.githubusercontent.com/u/153308555?s=200&v=4"></a> |
| **Current Sponsors** <br /> Any amount is appreciated. | <a href="https://github.com/kylemh" target="_blank"><img src="https://avatars.githubusercontent.com/u/9523719?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@kylemh"></a> <a href="https://github.com/theMosaad" target="_blank"><img src="https://avatars.githubusercontent.com/u/48773133?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@theMosaad"></a> <a href="https://github.com/acewf" target="_blank"><img src="https://avatars.githubusercontent.com/u/4835572?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@acewf"></a> <a href="https://github.com/dailydotdev" target="_blank"><img class="avatar" src="https://avatars.githubusercontent.com/u/41463883?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@dailydotdev"></a> <a href="https://github.com/codecov" target="_blank"><img class="avatar" src="https://avatars.githubusercontent.com/u/8226205?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@codecov"></a> <a href="https://github.com/sourcegraph" target="_blank"><img class="avatar" src="https://avatars.githubusercontent.com/u/3979584?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@sourcegraph"></a> <a href="https://github.com/getsentry" target="_blank"><img class="avatar" src="https://avatars.githubusercontent.com/u/1396951?s=150&amp;v=4" width="75" height="75" style="border-radius:100%;" alt="@getsentry"></a> |
Expand Down