Update readme.md

Author: jpomykala

README.md

@@ -1,23 +1,86 @@
-# Hello world javascript action
+# SimpleLocalize GitHub Action
+
+Action installs, configures, and runs the SimpleLocalize CLI with the version, command, and arguments of your choice.
+
+Learn more: https://simplelocalize.io/docs/cli/get-started/
 
-This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
 
 ## Inputs
 
-### `who-to-greet`
+### `api-key`
+
+The API key for SimpleLocalize. Default `""`.
+
+Example: `${{ secrets.SIMPLELOCALIZE_API_KEY }}`
+
+### `command`
+
+**Required** The name of command to run. Default `"status"`.
 
-**Required** The name of the person to greet. Default `"World"`.
+Example: `upload`, `auto-translate`, `download`, `publish`, `pull`
 
-## Outputs
+### `cli-version`
 
-### `time`
+**Required** The version of the SimpleLocalize CLI to use.
+All available versions can be found here: https://github.com/simplelocalize/simplelocalize-cli/releases
 
-The time we greeted you.
+Example: `2.2.0`
 
-## Example usage
+### `args`
 
-```yaml
-uses: actions/[email protected]
-with:
-  who-to-greet: 'Mona the Octocat'
+The arguments for the command. Default `""`.
+
+Example: `--uploadPath ./translations/{lang}.json --uploadFormat single-language-json --dryRun`
+
+# Examples of usage
+
+The workflow below will upload translations, auto-translate them,
+download translations, publish them and pull them to the hosting resources.
+
+```yml
+name: 'My project'
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Upload translations
+        uses: simplelocalize/github-action@v1
+        with:
+          api-key: ${{ secrets.SIMPLELOCALIZE_API_KEY }}
+          command: 'upload'
+          cli-version: '2.2.0'
+          args: '--uploadPath ./translations/{lang}.json --uploadFormat single-language-json --dryRun'
+      - name: Auto-translate project
+        uses: simplelocalize/github-action@v1
+        with:
+          api-key: ${{ secrets.SIMPLELOCALIZE_API_KEY }}
+          command: 'auto-translate'
+          cli-version: '2.2.0'
+      - name: Download translations
+        uses: simplelocalize/github-action@v1
+        with:
+          api-key: ${{ secrets.SIMPLELOCALIZE_API_KEY }}
+          command: 'download'
+          cli-version: '2.2.0'
+          args: '--downloadPath ./translations/{lang}.json --downloadFormat single-language-json'
+      - name: Publish translations
+        uses: simplelocalize/github-action@v1
+        with:
+          api-key: ${{ secrets.SIMPLELOCALIZE_API_KEY }}
+          command: 'publish'
+          cli-version: '2.2.0'
+          args: '--environment latest'
+      - name: Pull translations
+        uses: simplelocalize/github-action@v1
+        with:
+          api-key: ${{ secrets.SIMPLELOCALIZE_API_KEY }}
+          command: 'pull'
+          cli-version: '2.2.0'
+          args: "--pullPath ./translation-hosting-resources/ --environment latest --filterRegex '_index.json'"
 ```
+

action.yml

@@ -16,18 +16,7 @@ inputs:
   api-key:
     description: 'Project API Key'
     required: false
-  download-path:
-    description: 'Where files should be downloaded, e.g.: ./i18n/messages.json, ./i18n/messages/{lang}.json, ./i18n/messages/{lang}/{ns}.json'
-    required: false
-  download-format:
-    description: 'Choose a localization files format. Formats: https://simplelocalize.io/docs/general/file-formats/'
-    required: false
-  upload-path:
-    description: 'Which files should be uploaded, e.g.: ./i18n/messages.json, ./i18n/messages/{lang}.json, ./i18n/messages/{lang}/{ns}.json'
-    required: false
-  upload-format:
-    description: 'Choose a localization files format. Formats: https://simplelocalize.io/docs/general/file-formats/'
-    required: false
+    default: ''
   args:
     description: 'Custom arguments for the CLI command'
     required: false
@@ -45,30 +34,12 @@ runs:
         echo "Test SimpleLocalize"
         echo "command: ${{ inputs.command }}"
         echo "cli-version: ${{ inputs.cli-version }}"
-        if [ -z "${{ inputs.api-key }}" ]; then
-          echo "api-key: [empty]"
-        else
-          echo "api-key: [hidden]"
-        fi
-        echo "download-path: ${{ inputs.download-path }}"
-        echo "download-format: ${{ inputs.download-format }}"
-        echo "upload-path: ${{ inputs.upload-path }}"
-        echo "upload-format: ${{ inputs.upload-format }}"
         echo "args: ${{ inputs.args }}"
       shell: bash
     - name: "Download SimpleLocalize CLI"
       run: "curl -o simplelocalize.jar https://get.simplelocalize.io/binaries/${{ inputs.cli-version }}/simplelocalize-cli-${{ inputs.cli-version }}.jar"
       shell: bash
     - name: "Execute SimpleLocalize CLI Command"
-      run: |
-        if [[ "${{ inputs.command }}" = "download" ]]
-        then
-          java -jar simplelocalize.jar ${{ inputs.command }} ${{ inputs.args }} --download-path ${{ inputs.download-path }} --download-format ${{ inputs.download-format }}
-        elif [[ "${{ inputs.command }}" = "upload" ]]
-        then
-          java -jar simplelocalize.jar ${{ inputs.command }} ${{ inputs.args }} --upload-path ${{ inputs.upload-path }} --upload-format ${{ inputs.upload-format }}
-        else
-          java -jar simplelocalize.jar ${{ inputs.command }} ${{ inputs.args }}
-        fi
+      run: "java -jar simplelocalize.jar ${{ inputs.command }} ${{ inputs.args }}"
       shell: bash