From 261d2caaeb665e8aa48467dc059b2c1d7c2a67c0 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Thu, 31 Aug 2023 10:45:20 -0600 Subject: [PATCH] docs(readme): Add automatic vercel instructions --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d8649a07..eee76362 100644 --- a/README.md +++ b/README.md @@ -159,12 +159,12 @@ The Inkscape dependency is required for PNG rendering, as well as Segoe UI font
Instructions for Deploying to Heroku ($5-$7/month) - ### Step-by-step instructions for deploying to Heroku +### Step-by-step instructions for deploying to Heroku - 1. Sign in to **Heroku** or create a new account at - 2. Visit [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) to create a new Personal Access Token (no scopes required) - 3. Scroll to the bottom and click **"Generate token"** - 4. Click the Deploy button below +1. Sign in to **Heroku** or create a new account at +2. Visit [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) to create a new Personal Access Token (no scopes required) +3. Scroll to the bottom and click **"Generate token"** +4. Click the Deploy button below [![](https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png)](#) [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/DenverCoder1/github-readme-streak-stats/tree/main "Deploy to Heroku") @@ -181,8 +181,27 @@ The Inkscape dependency is required for PNG rendering, as well as Segoe UI font
Instructions for Deploying to Vercel (Free) - -### Step-by-step instructions for deploying to Vercel + +### Step-by-step instructions for deploying to Vercel (automatic) + +1. Sign in to **Vercel** or create a new account at +2. Visit [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) to create a new Personal Access Token (no scopes required) +3. Scroll to the bottom and click **"Generate token"** +4. Click the Deploy button below + +[![](https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png)](#) [![Deploy with Vercel](https://vercel.com/button)]() + +5. Create your repository by filling in a Repository Name and clicking "Create" +6. **Add the token** as a Config Var with the key `TOKEN`: + +![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/17a433d6-0aaa-4c69-9a53-6d4638318fbb) + +6. Click **"Deploy"** at the end of the form +7. Once the app is deployed, click the screenshot or continue to the dashboard to find your domain to use in place of `streak-stats.demolab.com` + +![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/32092461-5983-4fed-b21b-29be55ed85e8) + +### Step-by-step instructions for deploying to Vercel (manual) > **Note** PNG mode is not supported since Inkscape will not be installed.