From 6c5c32e2790806e1871559f71f6def5d629434a0 Mon Sep 17 00:00:00 2001 From: Steve Winton Date: Fri, 1 Nov 2019 07:48:28 -0500 Subject: [PATCH] Add build status, usage to README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index f7e6635..939ebfe 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ Configure AWS credential environment variables for use in other GitHub Actions. +GitHub Actions status + +This action adds configuration required by [the AWS CLI](https://aws.amazon.com/cli/) for use in subsequent actions. + +## Usage + +Add the following step to your workflow: + +```yaml + - name: Configure AWS Credentials + uses: aws/configure-aws-credentials-for-github-actions + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-default-region: us-east-2 + aws-default-output: json +``` + ## License Summary This code is made available under the MIT license.