Update README.md

2 years ago · 894561d6ae
parent 70d4f670ac
commit 894561d6ae
1 changed files with 8 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -2,8 +2,15 @@

 This action is a drop-in replacement for the official `actions/cache@v4` action.

+![image](https://github.com/runs-on/cache/assets/6114/e61c5b6f-aa86-48be-9e1b-baac6dce9b84)
+
 It will automatically store your caches in a dedicated RunsOn S3 bucket that lives close to your self-hosted runners, ensuring you get at least 200MiB/s download and upload throughput when using caches in your workflows.

 If no S3 bucket is provided, it will also transparently switch to the default behaviour. This means you can use this action and switch between RunsOn runners and official GitHub runners with no change.

-Please refer to [actions/cache](https://github.com/actions/cache) for usage.
+
+## Usage
+
+Simply replace `actions/cache@v4` with `runs-on/cache@v4`. All the official options are supported. 
+
+Please refer to [actions/cache](https://github.com/actions/cache) for usage.