docs: document that the main export returns a Promise

ljharb · ljharb · commit 0ed735f8f5c8 · 2021-11-08T09:08:45.000-08:00
diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ var getRuleFinder = require('./eslint-find-rules')
 var ruleFinder = getRuleFinder('path/to/eslint-config')
 
 // default to the `main` in your `package.json`
-// var ruleFinder = getRuleFinder()
+// var ruleFinder = await getRuleFinder()
 
 // get all the current, plugin, available and unused rules
 // without referring the extended files or documentation
diff --git a/src/lib/rule-finder.js b/src/lib/rule-finder.js
@@ -142,6 +142,6 @@ async function createRuleFinder(specifiedFile, options) {
   return new RuleFinder(config, options);
 }
 
-module.exports = function (specifiedFile, options = {}) {
+module.exports = async function (specifiedFile, options = {}) {
   return createRuleFinder(specifiedFile, options);
 };

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,6 @@ async function createRuleFinder(specifiedFile, options) {`
`142`	`142`	`return new RuleFinder(config, options);`
`143`	`143`	`}`
`144`	`144`
`145`		`-module.exports = function (specifiedFile, options = {}) {`
	`145`	`+module.exports = async function (specifiedFile, options = {}) {`
`146`	`146`	`return createRuleFinder(specifiedFile, options);`
`147`	`147`	`};`