Skip to content

Commit 3a098c0

Browse files
authored
docs(readme): Add automatic Vercel deploy instructions (#562)
1 parent 1af2a50 commit 3a098c0

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,12 @@ The Inkscape dependency is required for PNG rendering, as well as Segoe UI font
159159
<details>
160160
<summary><b>Instructions for Deploying to Heroku ($5-$7/month)</b></summary>
161161

162-
### Step-by-step instructions for deploying to Heroku
162+
### Step-by-step instructions for deploying to Heroku
163163

164-
1. Sign in to **Heroku** or create a new account at <https://heroku.com>
165-
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)
166-
3. Scroll to the bottom and click **"Generate token"**
167-
4. Click the Deploy button below
164+
1. Sign in to **Heroku** or create a new account at <https://heroku.com>
165+
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)
166+
3. Scroll to the bottom and click **"Generate token"**
167+
4. Click the Deploy button below
168168

169169
[![](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")
170170

@@ -181,8 +181,27 @@ The Inkscape dependency is required for PNG rendering, as well as Segoe UI font
181181

182182
<details>
183183
<summary><b>Instructions for Deploying to Vercel (Free)</b></summary>
184-
185-
### Step-by-step instructions for deploying to Vercel
184+
185+
### Step-by-step instructions for deploying to Vercel (automatic)
186+
187+
1. Sign in to **Vercel** or create a new account at <https://vercel.com>
188+
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)
189+
3. Scroll to the bottom and click **"Generate token"**
190+
4. Click the Deploy button below
191+
192+
[![](https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png)](#) [![Deploy with Vercel](https://vercel.com/button)](<https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDenverCoder1%2Fgithub-readme-streak-stats%2Ftree%2Fvercel&env=TOKEN&envDescription=GitHub%20Personal%20Access%20Token%20(no%20scopes%20required)&envLink=https%3A%2F%2Fgithub.com%2Fsettings%2Ftokens%2Fnew%3Fdescription%3DGitHub%2520Readme%2520Streak%2520Stats&project-name=streak-stats&repository-name=github-readme-streak-stats>)
193+
194+
5. Create your repository by filling in a Repository Name and clicking "Create"
195+
6. **Add the token** as a Config Var with the key `TOKEN`:
196+
197+
![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/17a433d6-0aaa-4c69-9a53-6d4638318fbb)
198+
199+
6. Click **"Deploy"** at the end of the form
200+
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`
201+
202+
![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/32092461-5983-4fed-b21b-29be55ed85e8)
203+
204+
### Step-by-step instructions for deploying to Vercel (manual)
186205

187206
> **Note** PNG mode is not supported since Inkscape will not be installed.
188207

0 commit comments

Comments
 (0)