From 56d0a829b57500c58b5e6fcd2100e3df1c38340b Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Tue, 5 Sep 2023 18:22:49 -0600 Subject: [PATCH] docs(faq): Add self-hosting to FAQ --- docs/faq.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 8570404e..1cf4d3a1 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,9 @@ # FAQ +## How do I create a Readme for my profile? + +A profile readme appears on your profile page when you create a repository with the same name as your username and add a `README.md` file to it. For example, the repository for the user [`DenverCoder1`](https://github.com/DenverCoder1) is located at [`DenverCoder1/DenverCoder1`](https://github.com/DenverCoder1/DenverCoder1). + ## How do I include GitHub Readme Streak Stats in my Readme? Markdown files on GitHub support embedded images using Markdown or HTML. You can customize your Streak Stats image on the [demo site](https://streak-stats.demolab.com/demo/) and use the image source in either of the following ways: @@ -71,6 +75,10 @@ You can [specify theme context](https://github.blog/changelog/2022-05-19-specify ``` -## How do I create a Readme for my profile? +## Why and how do I self-host GitHub Readme Streak Stats? -A profile readme appears on your profile page when you create a repository with the same name as your username and add a `README.md` file to it. For example, the repository for the user [`DenverCoder1`](https://github.com/DenverCoder1) is located at [`DenverCoder1/DenverCoder1`](https://github.com/DenverCoder1/DenverCoder1). +Self-hosting the code can be done online and only takes a couple minutes. The benefits include better uptime since it will use your own access token so will not run into ratelimiting issues and it allows you to customize the deployment for your own use case. + +### [📺 Click here for a video tutorial on how to self-host on Vercel](https://www.youtube.com/watch?v=maoXtlb8t44) + +See [Deploying it on your own](https://github.com/DenverCoder1/github-readme-streak-stats?tab=readme-ov-file#-deploying-it-on-your-own) in the Readme for detailed instructions.