Update README with AsyncOption documentation (#248)

* Update README with AsyncOption documentation

* Fix README sync workflow

Author: dbrattli

.github/workflows/readme-sync.yml

@@ -25,30 +25,18 @@ jobs:
           pipx install poetry
           poetry install --all-extras
 
-      - name: Create branch and update README
+      - name: Generate README.md
         run: |
-          # Create new branch
-          git checkout -b readme-sync-${{ github.sha }}
-
           # Generate new README.md
           poetry run ./make_readme.sh
 
-          # Setup git
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-
-          # Commit changes if README.md was modified
-          if ! git diff --quiet README.md; then
-            git add README.md
-            git commit -m "[auto] Sync README.md"
-            git push origin readme-sync-${{ github.sha }}
-          fi
-
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v7
         with:
+          commit-message: "[auto] Sync README.md from README.py"
           title: '[auto] Sync README.md from README.py'
           body: 'Auto-generated PR to sync README.md with changes from README.py'
-          branch: readme-sync-${{ github.sha }}
+          branch: "update-readme"
+          delete-branch: true
           base: ${{ github.ref }}
           labels: automated,documentation

README.md

@@ -496,7 +496,8 @@ The `AsyncOption[T]` type is the asynchronous version of `Option`. It allows you
 compose asynchronous operations that may return an optional value, using the Option type.
 This is particularly useful for handling optional values in asynchronous code, such as
 API calls that might not return a value, database queries that might not find a record,
-or any other I/O-bound tasks that might not produce a meaningful result.
+or any other I/O-bound tasks that might not produce a meaningful result. The AsyncOption
+builder was added in version 0.25.0.
 
 Similar to the `Option` effect, AsyncOption enables short-circuiting but for asynchronous
 operations. If any part of the function yields `Nothing`, the function is short-circuited

README.py

@@ -546,7 +546,8 @@ async def outer() -> AsyncGenerator[int, int]:
 compose asynchronous operations that may return an optional value, using the Option type.
 This is particularly useful for handling optional values in asynchronous code, such as
 API calls that might not return a value, database queries that might not find a record,
-or any other I/O-bound tasks that might not produce a meaningful result.
+or any other I/O-bound tasks that might not produce a meaningful result. The AsyncOption
+builder was added in version 0.25.0.
 
 Similar to the `Option` effect, AsyncOption enables short-circuiting but for asynchronous
 operations. If any part of the function yields `Nothing`, the function is short-circuited