Merge pull request codecov#59 from DavidCain/dcain/update_token_instructions

thomasrockhu · web-flow · commit 74883884e480 · 2020-12-09T21:42:04.000-05:00
Add GitHub Actions example, note no token needed
diff --git a/README.md b/README.md
@@ -4,6 +4,22 @@
 
 ## Guide
 
+### GitHub Actions
+A minimal configuration for public repos:
+
+```yml
+steps:
+  # (Other steps go here)
+  - name: "Upload coverage to Codecov"
+    uses: codecov/codecov-action@v1
+    with:
+      fail_ci_if_error: true
+```
+
+See [codecov/codecov-action](https://github.com/codecov/codecov-action) for
+more information, a [detailed example](https://github.com/codecov/codecov-action#example-workflowyml-with-codecov-action),
+and other options.
+
 ### Travis Setup
 
 Add the following to your `.travis.yml`:
@@ -66,7 +82,9 @@ commands = codecov
 
 ## Caveats
 ### Private Repo
-Repository tokens are required for (a) all private repos, (b) public repos not using Travis-CI, CircleCI or AppVeyor. Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
+Repository tokens are required for (a) all private repos, (b) public repos not using the GitHub Actions, Travis CI, CircleCI or AppVeyor.
+
+Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
 
 ### Cobertura Reports
 Cobertura reports can expire - Codecov will reject reports that are older than 12 hours. The logs contain details if a report expired.
