update readme

Author: mgrybyk

.github/workflows/report_test.yml

@@ -40,7 +40,7 @@ jobs:
           ref: test-action # branch name
           path: test-action-dir # checkout path
 
-      - run: cd test-action-dir && echo 1>>f && git status -s && git diff --staged --name-only
+      - run: cd test-action-dir && echo '1' >> f && git status -s && git diff --staged --name-only
       - name: Local git-commit-pull-push-action 1
         uses: ./
         with:
@@ -49,7 +49,7 @@ jobs:
           commit_message: message ${{ github.run_id }}
           pull_args: --dry-run
 
-      - run: cd test-action-dir && echo 2>>f && git status -s && git diff --staged --name-only
+      - run: cd test-action-dir && echo '2' >> f && git status -s && git diff --staged --name-only
       - name: Local git-commit-pull-push-action 2
         uses: ./
         with:

README.md

@@ -4,15 +4,24 @@ Runs git add, git commit, git pull and git push.
 
 The action flow:
 
-1. git add .
+1. `git add .`
 2. check if there are any changed files
-3. git commit 
-4. git pull (with args)
-5. git push
+3. `git commit`
+4. `git pull` (with args)
+5. `git push`
 
 Originally designed to run `git pull --rebase -X ours` or `git pull --rebase -X theirs` after commit to help pushing changed to `gh-pages`.
 
 ## Usage
 
-todo
+```yaml
+- run: cd test-action-dir && echo 1>>f && git status -s && git diff --staged --name-only
+- name: Git Commit and Push Action
+  uses: mgrybyk/git-commit-pull-push-action@v1
+  with:
+    repository: test-action-dir
+    branch: test-action
+    commit_message: Apply automatic changes
+    pull_args: --rebase -X theirs
+```