Update README with local composite action example and correct parameters

Author: karldreher

.github/composite/docs/README.md

@@ -1,53 +1,73 @@
-# Action pull request another repository
-This GitHub Action copies a folder from the current repository to a location in another repository and create a pull request.
+# Copy and Pull Request to Another Repository
 
-This Action is a modified version of [paygoc6/action-pull-request-another-repo](https://github.com/paygoc6/action-pull-request-another-repo).
+This GitHub Action copies a folder from the current repository to a location in another repository and creates a pull request.
+
+This is a local composite action based on [chkn/[email protected]](https://github.com/chkn/MDRCNY-Actions-CPR), which is a modified version of [paygoc6/action-pull-request-another-repo](https://github.com/paygoc6/action-pull-request-another-repo).
 
 ## Example Workflow
-    name: Push File
-
-    on: push
-
-    jobs:
-      pull-request:
-        runs-on: ubuntu-latest
-        steps:
-        - name: Checkout
-          uses: actions/checkout@v2
-
-        - name: Create pull request
-          uses: MDRCNY/[email protected]
-          env:
-            API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
-          with:
-            source_folder: 'source-folder'
-            destination_repo: 'user-name/repository-name'
-            destination_folder: 'folder-name'
-            destination_base_branch: 'branch-name'
-            destination_head_branch: 'branch-name'
-            user_email: '[email protected]'
-            user_name: 'user-name'
-            pull_request_reviewers: 'reviewers'
-            title: 'title'
-            body: 'body'
-
-## Variables
-* source_folder: The folder to be moved. Uses the same syntax as the `cp` command. Incude the path for any files not in the repositories root directory.
-* destination_repo: The repository to place the file or directory in.
-* destination_folder: [optional] The folder in the destination repository to place the file in, if not the root directory.
-* user_email: The GitHub user email associated with the API token secret.
-* user_name: The GitHub username associated with the API token secret.
-* destination_base_branch: [optional] The branch into which you want your code merged. Default is `main`.
-* destination_head_branch: The branch to create to push the changes. Cannot be `master` or `main`.
-* pull_request_reviewers: [optional] The pull request reviewers. It can be only one (just like 'reviewer') or many (just like 'reviewer1,reviewer2,...')
-* title: [optional] The pull request title.
-* body: [optional] The pull request body.
-
-## ENV
-* API_TOKEN_GITHUB: You must create a personal access token in you account. Follow the link:
-- [Personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
-
-> You must select the scopes: 'repo = Full control of private repositories', 'admin:org = read:org' and 'write:discussion = Read:discussion';
+
+```yaml
+name: Copy Docs to Another Repo
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  copy-and-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Copy files and create pull request
+        uses: ./.github/composite/docs
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
+        with:
+          source_path: 'api-reference'
+          destination_repo: 'glideapps/other-repo'
+          destination_path: 'docs/api'
+          destination_base_branch: 'main'
+          destination_head_branch: 'update-api-docs'
+          user_email: '[email protected]'
+          user_name: 'Glide Bot'
+          label: 'automated-update'
+          pull_request_reviewers: 'reviewer1,reviewer2'
+          title: 'Update API docs from api-docs repo'
+          body: 'Automated update of API documentation'
+```
+
+## Inputs
+
+* **source_path** (required): The folder or file to be copied. Uses the same syntax as the `cp` command. Include the path for any files not in the repository's root directory.
+* **destination_repo** (required): The repository to place the files in (format: `owner/repo-name`).
+* **destination_path** (optional): The folder in the destination repository to place the files in, if not the root directory.
+* **destination_head_branch** (required): The branch to create to push the changes. Cannot be `master` or `main`.
+* **destination_base_branch** (optional): The branch into which you want your code merged. Default is `main`.
+* **user_email** (required): The GitHub user email associated with the API token secret.
+* **user_name** (required): The GitHub username associated with the API token secret.
+* **label** (required): The label to apply to the pull request.
+* **pull_request_reviewers** (optional): The pull request reviewers. Can be a single reviewer (e.g., `reviewer`) or multiple comma-separated reviewers (e.g., `reviewer1,reviewer2`).
+* **title** (optional): The pull request title. Defaults to `Pull Request for Repo: <github.repository>`.
+* **body** (optional): The pull request body. Defaults to a single space.
+
+## Outputs
+
+* **pr_url**: The URL of the created pull request.
+* **created**: Boolean indicating whether the pull request was created (`true` or `false`).
+
+## Environment Variables
+
+* **API_TOKEN_GITHUB** (required): A GitHub Personal Access Token with the following scopes:
+  - `repo` - Full control of private repositories
+  - `admin:org` (read:org) - Read organization membership
+  - `write:discussion` (read:discussion) - Read discussions
+
+  See [Creating a Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for instructions.
+
+  Store this token as a repository secret and reference it in your workflow as shown in the example above.
 
 
 ## Behavior Notes