Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Dec 20, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e72377
feat(docs): update readme to include free rc
tknickman Dec 20, 2024
2fe3894
Update other readme’s
tknickman Dec 20, 2024
b62b253
Update doctoc
tknickman Dec 20, 2024
5196f03
Add Nx note
tknickman Dec 20, 2024
25a3f04
fix
tknickman Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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 -->

Expand Down Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions packages/remote-nx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
3 changes: 3 additions & 0 deletions packages/remote-rush/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
3 changes: 3 additions & 0 deletions packages/remote/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down
Loading