update readme to fix cjs usage

domharrington · Apr 13, 2020 · 7cbef29 · 7cbef29
1 parent cbcb26a
commit 7cbef29
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ npm install gitlog --save
 ## Usage
 
 ```js
-const gitlog = require("gitlog");
+const gitlog = require("gitlog").default;
 
 const options = {
   repo: __dirname + "/test-repo-folder",
@@ -34,8 +34,10 @@ gitlog(options, function (error, commits) {
   console.log(commits);
 });
 
+const { gitlogPromise } = require("gitlog");
+
 // Asynchronous (with Promise)
-gitlog(options)
+gitlogPromise(options)
   .then((commits) => console.log(commits))
   .catch((err) => console.log(err));
 ```