feat(docs): update readme to mention free Vercel Remote Cache (#25)

vercel · Dec 20, 2024 · 63b2dd7 · 63b2dd7
1 parent 8855824
commit 63b2dd7
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,6 @@
   <img width="60%" alt="@vercel/remote-cache" src="https://user-images.githubusercontent.com/2933988/191345252-678e203e-3810-4501-b7e5-b6230cad89de.png#gh-light-mode-only">
 </p>
 
-
 <p align="center">
   <a aria-label="Vercel logo" href="https://vercel.com">
     <img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20">
@@ -14,9 +13,13 @@
 
 [![Node CI](https://github.com/vercel/remote-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/vercel/remote-cache/actions/workflows/ci.yml)
 
-An SDK for Remote Caching on [Vercel](https://vercel.com)
+An SDK for Remote Caching on [Vercel](https://vercel.com).
+
+> [!TIP]
+> Vercel Remote Cache is now free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
 
 ## Table of Contents
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -45,10 +48,10 @@ Build systems and tools that integrate with Vercel Remote Caching.
 
 ## Packages
 
-| Name                                         | Description                                              | Package                                                              |
-| -------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------- |
-| [@vercel/remote](packages/remote/)           | An SDK for remote artifact caching on Vercel             | [![@vercel/remote](https://img.shields.io/npm/v/@vercel/remote)](https://npmjs.org/@vercel/remote)           |
-| [@vercel/remote-nx](packages/remote-nx/)     | Remote caching plugin for Nx using Vercel Remote Cache   | [![@vercel/remote-nx](https://img.shields.io/npm/v/@vercel/remote-nx)](https://npmjs.org/@vercel/remote-nx)     |
+| Name                                         | Description                                              | Package                                                                                                           |
+| -------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| [@vercel/remote](packages/remote/)           | An SDK for remote artifact caching on Vercel             | [![@vercel/remote](https://img.shields.io/npm/v/@vercel/remote)](https://npmjs.org/@vercel/remote)                |
+| [@vercel/remote-nx](packages/remote-nx/)     | Remote caching plugin for Nx using Vercel Remote Cache   | [![@vercel/remote-nx](https://img.shields.io/npm/v/@vercel/remote-nx)](https://npmjs.org/@vercel/remote-nx)       |
 | [@vercel/remote-rush](packages/remote-rush/) | Remote caching plugin for Rush using Vercel Remote Cache | [![@vercel/remote-rush](https://img.shields.io/npm/v/@vercel/remote-rush)](https://npmjs.org/@vercel/remote-rush) |
 
 ## Contributing

diff --git a/packages/remote-nx/README.md b/packages/remote-nx/README.md
@@ -4,6 +4,12 @@
 
 This project implements a task runner for [@nrwl/nx](https://nx.dev) that caches build artifacts in the Vercel Remote Cache.
 
+> [!WARNING]  
+> As of Nx version 19.8+ may need to pay a license fee to Nx to continue using Vercel Remote Cache.
+
+> [!TIP]
+> Vercel Remote Cache is now free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
+
 ## Table of Contents
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

diff --git a/packages/remote-rush/README.md b/packages/remote-rush/README.md
@@ -4,6 +4,9 @@
 
 This is a [Rush](https://rushjs.io/) plugin for using Vercel Remote Cache provider during the "build" and "rebuild" command.
 
+> [!TIP]
+> Vercel Remote Cache is now free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
+
 ## Table of Contents
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

diff --git a/packages/remote/README.md b/packages/remote/README.md
@@ -6,6 +6,9 @@ When you build your project a set of build outputs are created. These build outp
 
 The Vercel Remote Caching SDK is a thin layer over our existing API can be added to your build system to enable remote artifact caching.
 
+> [!TIP]
+> Vercel Remote Cache is now free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
+
 ## Table of Contents
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->