Skip to content

Commit e809a07

Browse files
committed
docs: enhance README with badges and contributing section
- Add npm downloads badge - Add tagline with better scanability - Add contributing section with links to community docs - Add footer with Sebastian Software branding
1 parent a18e7fe commit e809a07

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# eslint-plugin-lingui-typescript
22

33
[![npm version](https://img.shields.io/npm/v/eslint-plugin-lingui-typescript.svg)](https://www.npmjs.com/package/eslint-plugin-lingui-typescript)
4+
[![npm downloads](https://img.shields.io/npm/dm/eslint-plugin-lingui-typescript.svg)](https://www.npmjs.com/package/eslint-plugin-lingui-typescript)
45
[![CI](https://github.com/sebastian-software/eslint-plugin-lingui-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/sebastian-software/eslint-plugin-lingui-typescript/actions/workflows/ci.yml)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
67

7-
ESLint plugin for [Lingui](https://lingui.dev/) with TypeScript type-aware rules.
8+
> 🔍 Type-aware ESLint rules for [Lingui](https://lingui.dev/) — catch unlocalized strings with zero configuration using TypeScript's type system.
89
910
## Why TypeScript?
1011

@@ -212,6 +213,10 @@ The `no-unlocalized-strings` rule has different options because TypeScript types
212213

213214
5. Review your ignore lists — many entries may no longer be needed thanks to type-aware detection.
214215

216+
## Contributing
217+
218+
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a PR.
219+
215220
## Related Projects
216221

217222
- [Lingui](https://lingui.dev/) – The excellent i18n library this plugin is built for. Provides powerful macros like `t`, `<Trans>`, and `plural` for seamless internationalization.
@@ -221,3 +226,7 @@ The `no-unlocalized-strings` rule has different options because TypeScript types
221226
## License
222227

223228
[MIT](LICENSE)
229+
230+
---
231+
232+
Made with ❤️ by [Sebastian Software](https://www.sebastian-software.de)

0 commit comments

Comments
 (0)