libgfi - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "libgfi",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A module for finding good-first-issues in open source projects.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -75,2 +75,21 @@ # libgfi
 
+Passing in GitHub credentials (see Octokit's [authentication documentation](https://octokit.github.io/rest.js/#authentication) for more details) for authentication to exponentially increase the rate limit:
+
+```js
+const gfi = require('libgfi')
+
+const options = {
+  auth: '<replace_with_your_github_secret_personal_access_token>' // or username/password + 2fa, or app installation access token
+}
+
+let log = async () => {
+  let issues = await gfi('microsoft', options) // search the 'microsoft' GitHub organization
+  issues.forEach(function (issue) {
+    console.log('#' + issue.pr + ': ' + issue.title)
+  })
+}
+
+log()
+```
+
 ### Examples
@@ -77,0 +96,0 @@

No alert changes

Improved metrics

Total package byte prevSize

10521

6.26%

Number of lines in readme file

127

17.59%

No dependency changes