Merge pull request #34 from port-labs/github-sync-readme-improvements

README improvement to GitHub issues sync params

Author: matarpeles

README.md

@@ -233,9 +233,10 @@ Generated Scorecard issue for the bronze level:
 | `blueprint`                  | Blueprint identifier                                                                                                                                                                                     | true     |         |
 | `scorecard`                  | Scorecard identifier                                                                                                                                                                                     | true     |         |
 | `opeation_kind`              | What operation should the sender do, leave at - `issue_handler`                                                                                                                            | true     |         |
+| `target_kind`                | leave at - `github`                                                                                                                            | true     |         |
 | `filter_rule`                | The [rule filter](https://docs.getport.io/search-and-query/#rules) to apply on the data queried from Port                                                                                                | false    |         |
-| `github_api_url`          | Github API URL. We recommend setting this to Github's `github.api_url` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values)   URL                                                                                                                                                                                        | true     |         |
-| `github_repository`            | The Github Repository. We recommend setting this to Github's `github.repository` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values)                                                   | true     |         |
+| `github_api_url`          | Github API URL. We recommend setting this to Github's `github.api_url` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values)   URL. Using GitHub Cloud, you should use - `https://api.github.com`                                                                                                                                                                                        | true     |         |
+| `github_repository`            | The Github Repository. We recommend setting this to Github's `github.repository` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values).  If set manually, should be in the format `org_name/repo_name`, for example `port-labs/port-sender`                                                  | true     |         |
 | `github_token`          | The Github's Token used for create/get/update operations on issues. We recommend setting this to Github's `github.token` [context variable](https://docs.github.com/en/actions/learn-github-actions/variables#using-contexts-to-access-variable-values), and granting it default `issues: write` [permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)                                                                                                                                                                           | true     |         |
 
 This example will create a Github issue for every service in every level that are not completed in the `productionReadiness` scorecard for the Backend Team.