docs: document that the main export returns a Promise

sarbbottam · Nov 8, 2021 · 0ed735f · 0ed735f
1 parent 18248f6
commit 0ed735f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
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);
 };