From 1318c368d3d9143291adb9f9e7a06f6510753e41 Mon Sep 17 00:00:00 2001 From: Marc Cuva Date: Wed, 30 Oct 2019 16:32:48 -0700 Subject: [PATCH] Correct capitolization of github --- action.yml | 2 +- readme.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/action.yml b/action.yml index 8c4961e0..73425564 100644 --- a/action.yml +++ b/action.yml @@ -1,4 +1,4 @@ -name: 'ReadMe API Github Sync' +name: 'ReadMe API GitHub Sync' description: 'Sync API Spec files to ReadMe automatically' author: 'ReadMe' branding: diff --git a/readme.md b/readme.md index 710dfedc..1918c350 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ -# ReadMe Github Sync +# ReadMe GitHub Sync -A Github action for syncing to ReadMe! +A GitHub action for syncing to ReadMe! View the full docs for setup here: [https://docs.readme.com/docs/automatically-sync-api-specification-with-github](https://docs.readme.com/docs/automatically-sync-api-specification-with-github) @@ -24,8 +24,8 @@ jobs: - uses: readmeio/github-readme-sync@779b8771eb696ea487782f755aa11907d006a8b3 with: repo-token: '${{ secrets.GITHUB_TOKEN }}' # allows us to get the contents of your spec file + readme-api-id: 'Unique 12 Byte Id' # Autogenerated to match API Settings in ReadMe to synced file! View docs to get this! api-file-path: 'swagger.json' # path to api spec file readme-api-key: 'README API KEY' # ReadMe API key - readme-api-id: 'Unique 12 Byte Id' # Autogenerated to match API Settings in ReadMe to synced file! View docs to get this! readme-api-version: '1.0' # ReadMe version to sync to ```