fix: add details + examples to description

JulianCataldo · Aug 26, 2022 · fda5c77 · fda5c77
1 parent 0234d34
commit fda5c77
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,25 @@
 
 A `retext` plugin for checking popular names casing.
 
+Examples:
+
+- ⚠️ `macbook` → ✅ **`MacBook`**
+- ⚠️ `MacOS` → ✅ **`macOS`**
+- 🤔…
+- ⚠️ `ESBuild` → ✅ **`esbuild`**
+- ⚠️ `eslint` → ✅ **`ESLint`**
+- 😭…
+
+For:
+
+- [Abbreviates](https://github.com/antfu/case-police/blob/main/dict/abbreviates.json)
+- [Brands](https://github.com/antfu/case-police/blob/main/dict/brands.json)
+- [General](https://github.com/antfu/case-police/blob/main/dict/general.json)
+- [Products](https://github.com/antfu/case-police/blob/main/dict/products.json)
+- [Softwares](https://github.com/antfu/case-police/blob/main/dict/softwares.json)
+
+---
+
 Dictionaries are from [`case-police`](https://github.com/antfu/case-police).
 
 # Demo