From 63b2dd749fcde2978b76c798a09de99ef0841945 Mon Sep 17 00:00:00 2001 From: Thomas Knickman Date: Fri, 20 Dec 2024 13:45:11 -0500 Subject: [PATCH] feat(docs): update readme to mention free Vercel Remote Cache (#25) --- README.md | 15 +++++++++------ packages/remote-nx/README.md | 6 ++++++ packages/remote-rush/README.md | 3 +++ packages/remote/README.md | 3 +++ 4 files changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9554e1b..eb52bac 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ @vercel/remote-cache

-

@@ -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 + @@ -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 index 2b48782..9d9e502 100644 --- 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 diff --git a/packages/remote-rush/README.md b/packages/remote-rush/README.md index 34a78ee..3dc9bcd 100644 --- 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 diff --git a/packages/remote/README.md b/packages/remote/README.md index 4105093..27b5c83 100644 --- 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