Merge pull request #63 from jnwei/update-documentation-and-examples

Update documentation and examples

Author: ethanholz

README.md

@@ -3,6 +3,8 @@
 
 A simple library for building infrastructure provisioning GitHub Actions via Docker in Python. This project provides scaffolds for starting and stopping cloud instances and all the required interactions to register with the GitHub API. Additionally, we provide some helper functions for environment variable parsing and GitHub Actions native logging.
 
+Documentation for GHA Runner may be found at: [https://gha-runner.readthedocs.io/en/latest/aws/](https://gha-runner.readthedocs.io/en/latest/aws/)
+
 ## Implementations
 - [start-aws-gha-runner](https://github.com/omsf/start-aws-gha-runner) and [stop-aws-gha-runner](https://github.com/omsf/stop-aws-gha-runner) (to see this in action take a look at the example used on [AWS](docs/aws.md))
 

docs/aws.md

@@ -119,7 +119,7 @@ jobs:
     needs:
       - start-aws-runner
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Print disk usage
         run: "df -h"
       - name: Print Docker details