Merge pull request #4 from devalog/readme-edits

Clarify README use cases

Author: mattblank11

README.md

@@ -1,10 +1,13 @@
 # sync-openapi
 
-A GitHub Action to sync files/folders from your source repository to a target repository (like fern-config).
+A GitHub Action to sync OpenAPI specifications with your Fern setup. Choose your scenario:
+
+- **Case 1: Sync from public URL (most common).** Your OpenAPI spec is hosted at a publicly available URL and you want to pull it into your fern folder
+- **Case 2: Sync between repositories**: Your OpenAPI spec lives in one repository and you want to sync it to another repository where your fern folder lives (like fern-config)
 
 ## Usage
 
-### Case 1: Sync files/folders between repositories
+### Case 1: Sync specs using `fern api update` (recommended)
 
 1. In your your source repo, create a file named `sync-openapi.yml` in `.github/workflows/`. 
 2. Include the following contents in `sync-openapi.yml`: 
@@ -20,32 +23,24 @@ on:                                              # additional custom triggers ca
     - cron: '0 3 * * *'                          # everyday at 3:00 AM UTC
 
 jobs:
-  sync:
+  update-from-source:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Sync OpenAPI spec to target repo
+        with:
+          token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
+      - name: Update API with Fern
         uses: fern-api/sync-openapi@v2
         with:
-          repository: <your-org>/<your-target-repo>
-          token: ${{ secrets.<PAT_TOKEN_NAME> }}
-          sources:                                # all paths are relative to source repository root
-            - from: path/to/source/dir            # supports folder syncing
-              to: path/to/target/dir    
-              exclude:                            # optional
-                - "path/to/file/to/exclude.yaml"  # supports individual file exclusion
-                - "path/to/dir/to/exclude/**"     # supports glob-based pattern matching
-                - "path/to/files/*_test.yaml"
-            - from: path/to/source/file.yaml      # supports individual file syncing
-              to: path/to/target/file.yaml    
-                ....
-
-          branch: main
-          auto_merge: true                        # you MUST use auto_merge: true with branch: main
+          update_from_source: true
+          token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
+          branch: 'update-api'
+          auto_merge: false                        # you MUST use auto_merge: true with branch: main
+          add_timestamp: true
 
 ```
 
-### Case 2: Sync specs using `fern api update`
+### Case 2: Sync files/folders between repositories
 
 1. In your your source repo, create a file named `sync-openapi.yml` in `.github/workflows/`. 
 2. Include the following contents in `sync-openapi.yml`: 
@@ -61,25 +56,30 @@ on:                                              # additional custom triggers ca
     - cron: '0 3 * * *'                          # everyday at 3:00 AM UTC
 
 jobs:
-  update-from-source:
+  sync:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
-      - name: Update API with Fern
+      - name: Sync OpenAPI spec to target repo
         uses: fern-api/sync-openapi@v2
         with:
-          update_from_source: true
-          token: ${{ secrets.OPENAPI_SYNC_TOKEN }}
-          branch: 'update-api'
-          auto_merge: false                        # you MUST use auto_merge: true with branch: main
-          add_timestamp: true
-
-```
-
+          repository: <your-org>/<your-target-repo>
+          token: ${{ secrets.<PAT_TOKEN_NAME> }}
+          sources:                                # all paths are relative to source repository root
+            - from: path/to/source/dir            # supports folder syncing
+              to: path/to/target/dir    
+              exclude:                            # optional
+                - "path/to/file/to/exclude.yaml"  # supports individual file exclusion
+                - "path/to/dir/to/exclude/**"     # supports glob-based pattern matching
+                - "path/to/files/*_test.yaml"
+            - from: path/to/source/file.yaml      # supports individual file syncing
+              to: path/to/target/file.yaml    
+                ....
 
+          branch: main
+          auto_merge: true                        # you MUST use auto_merge: true with branch: main
 
+```
 ## Inputs
 
 | Input               | Description                                                                                                                                 | Required | Default                  | Case    |