From b42b80962c756dcc43cd35f18f74cb69f591b428 Mon Sep 17 00:00:00 2001
From: Zeke Sikelianos <zeke@sikelianos.com>
Date: Thu, 11 Jan 2018 21:01:08 -0800
Subject: [PATCH] add gotcha section to readme about mixed-case packages

---
 readme.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/readme.md b/readme.md
index 947cd3722..9d5a9c50c 100644
--- a/readme.md
+++ b/readme.md
@@ -58,6 +58,21 @@ npm i -g all-the-package-names
 all-the-package-names | grep spell
 ```
 
+## ⚠️ Gotchas
+
+Note that while mixed-case package names are no longer allowed to be published
+to the npm registry, there are over 2800 legacy mixed-case packages, many of 
+which have the same spelling as other existing lowercase packages. See [nice-registry/mixed-case-package-names](https://github.com/nice-registry/mixed-case-package-names)
+for the the full list.
+
+To avoid the mixed-case names when working with this data, 
+just filter them out:
+
+```js
+const names = require('all-the-package-names')
+  .filter(name => name === name.toLowerCase())
+```
+
 ## Tests
 
 ```sh