Skip to content

Commit

Permalink
Update other readme’s
Browse files Browse the repository at this point in the history
  • Loading branch information
tknickman committed Dec 20, 2024
1 parent 3e72377 commit 2fe3894
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 24 deletions.
13 changes: 9 additions & 4 deletions packages/remote-nx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@

This project implements a task runner for [@nrwl/nx](https://nx.dev) that caches build artifacts in the 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 -->

- [Setup](#setup)
- [Usage](#usage)
- [Run it 🚀](#run-it-)
- [Advanced Configuration](#advanced-configuration)
- [@vercel/remote-nx](#vercelremote-nx)
- [Table of Contents](#table-of-contents)
- [Setup](#setup)
- [Usage](#usage)
- [Run it 🚀](#run-it-)
- [Advanced Configuration](#advanced-configuration)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down
25 changes: 15 additions & 10 deletions packages/remote-rush/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,25 @@

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 -->

- [Setting up a new Rush monorepo with Vercel Remote Cache](#setting-up-a-new-rush-monorepo-with-vercel-remote-cache)
- [Setup Rush monorepo](#setup-rush-monorepo)
- [Add caching](#add-caching)
- [Add remote caching with Vercel](#add-remote-caching-with-vercel)
- [Download and install the @vercel/remote-rush plugin](#download-and-install-the-vercelremote-rush-plugin)
- [Configuring token for the Remote Cache](#configuring-token-for-the-remote-cache)
- [Using Environment Variables](#using-environment-variables)
- [Using Rush user store](#using-rush-user-store)
- [Authenticating during a Vercel Build](#authenticating-during-a-vercel-build)
- [Finally](#finally)
- [@vercel/remote-rush](#vercelremote-rush)
- [Table of Contents](#table-of-contents)
- [Setting up a new Rush monorepo with Vercel Remote Cache](#setting-up-a-new-rush-monorepo-with-vercel-remote-cache)
- [Setup Rush monorepo](#setup-rush-monorepo)
- [Add caching](#add-caching)
- [Add remote caching with Vercel](#add-remote-caching-with-vercel)
- [Download and install the @vercel/remote-rush plugin](#download-and-install-the-vercelremote-rush-plugin)
- [Configuring token for the Remote Cache](#configuring-token-for-the-remote-cache)
- [Using Environment Variables](#using-environment-variables)
- [Using Rush user store](#using-rush-user-store)
- [Authenticating during a Vercel Build](#authenticating-during-a-vercel-build)
- [Finally](#finally)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down
25 changes: 15 additions & 10 deletions packages/remote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,25 @@ 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 -->

- [Installation](#installation)
- [Getting Started](#getting-started)
- [Authentication](#authentication)
- [Using buffers](#using-buffers)
- [Using streams](#using-streams)
- [Creating a Remote Cache Client](#creating-a-remote-cache-client)
- [Checking artifact exists](#checking-artifact-exists)
- [Retrieve artifact](#retrieve-artifact)
- [Store artifact](#store-artifact)
- [Errors](#errors)
- [Vercel Remote Caching SDK](#vercel-remote-caching-sdk)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Authentication](#authentication)
- [Using buffers](#using-buffers)
- [Using streams](#using-streams)
- [Creating a Remote Cache Client](#creating-a-remote-cache-client)
- [Checking artifact exists](#checking-artifact-exists)
- [Retrieve artifact](#retrieve-artifact)
- [Store artifact](#store-artifact)
- [Errors](#errors)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down

0 comments on commit 2fe3894

Please sign in to comment.