Warn against filename-unfriendly chars in moduleName (#187)

Closes #168.
cosmiconfig · Nov 2, 2019 · c531f20 · c531f20
1 parent 8f4a0f0
commit c531f20
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -118,6 +118,8 @@ Type: `string`. **Required.**
 
 Your module name. This is used to create the default [`searchPlaces`] and [`packageProp`].
 
+If your [`searchPlaces`] value will include files, as it does by default (e.g. `${moduleName}rc`), your `moduleName` must consist of characters allowed in filenames. That means you should not copy scoped package names, such as `@my-org/my-package`, directly into `moduleName`.
+
 **[`cosmiconfigOptions`] are documented below.**
 You may not need them, and should first read about the functions you'll use.