From 4582d54fd3d27d9130327cdb51361c32016fa400 Mon Sep 17 00:00:00 2001
From: Tom Hu <88201630+thomasrockhu-codecov@users.noreply.github.com>
Date: Wed, 13 Nov 2024 13:18:13 -0500
Subject: [PATCH] Update README.md (#1639)

* Update README.md

* Add in the deprecated args
---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 1ea61f3f3f..98ea0df342 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,29 @@
 [![Workflow for Codecov Action](https://github.com/codecov/codecov-action/actions/workflows/main.yml/badge.svg)](https://github.com/codecov/codecov-action/actions/workflows/main.yml)
 ### Easily upload coverage reports to Codecov from GitHub Actions
 
+## v5 Release
+`v5` of the Codecov GitHub Action will use the [Codecov Wrapper](https://github.com/codecov/wrapper) to encapsulate the [CLI](https://github.com/codecov/codecov-cli). This will help ensure that the Action gets updates quicker.
+
+### Migration Guide
+The `v5` release also coincides with the opt-out feature for tokens for public repositories. In the repository settings page in codecov.io, you can set the ability for Codecov to receive a coverage report from ANY souce. This will allow contributors or other members of a repository to upload without needing access to the Codecov token.
+
+**The following arguments have been changed**
+- `file` (this has been deprecated in favor of `files`)
+- `plugin` (this has been deprecated in favor of `plugins`)
+  
+The following arguments have been added:
+
+- `binary`
+- `gcov_args`
+- `gcov_executable`
+- `gcov_ignore`
+- `gcov_include`
+- `report_type`
+- `skip_validation`
+- `swift_project`
+
+You can see their usage in the `action.yml` [file](https://github.com/codecov/codecov-action/blob/main/action.yml).
+
 ## v4 Release
 `v4` of the Codecov GitHub Action will use the [Codecov CLI](https://github.com/codecov/codecov-cli) to upload coverage reports to Codecov.