adding more to readme, updating gitignore

joshjohanning · joshjohanning · commit ac401a3b9cbb · 2023-04-07T09:43:42.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.csv
 *.txt
 **/.DS_Store
+*.pem
diff --git a/scripts/README.md b/scripts/README.md
@@ -100,6 +100,8 @@ This script will generate a JWT for a GitHub App. It will use the private key an
     - You will need to have the `jwt` package installed via `pip3`: `pip3 install jwt`
     - The JWT is valid for 10 minutes (maximum)
 
+Script sourced from [GitHub docs](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app#example-using-python-to-generate-a-jwt).
+
 ## get-app-tokens-for-each-installation.sh
 
 This script will generate generate a JWT for a GitHub app and use that JWT to generate installation tokens for each org installation. The installation tokens, returned as `ghs_abc`, can then be used for normal API calls. It will use the private key and app ID from the GitHub App's settings page and the `get-app-jwt.py` script to generate the JWT, and then use the JWT to generate the installation tokens for each org installation.
@@ -118,6 +120,11 @@ Output example:
 > 
 >  ... token: ghs_xyz
 
+Docs:
+- [Generate a JWT for a GitHub App](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app#example-using-python-to-generate-a-jwt)
+- [Generating an installation access token for a GitHub App](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app#generating-an-installation-access-token)
+- [List installations for the authenticated app](https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#list-installations-for-the-authenticated-app)
+
 ## get-new-outside-collaborators-added-to-repository.sh
 
 This script will generate a list of new outside collaborators added to a repository. It uses a database file specified to determine if any new users were added to the repository and echo them to the console for review.

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 *.csv
 *.txt
 **/.DS_Store
 +*.pem