From 5e28f0ebde331b9b560cd14af69137e8a1402a85 Mon Sep 17 00:00:00 2001 From: Cyb3rHunter1337 <122138538+ZeroHack01@users.noreply.github.com> Date: Sat, 17 May 2025 00:46:41 +0600 Subject: [PATCH] Update README.md --- README.md | 343 +++++++++++++++++++++++------------------------------- 1 file changed, 146 insertions(+), 197 deletions(-) diff --git a/README.md b/README.md index bd2354fa..3a61be87 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ -

- -

Github Readme Streak Stats

-

+# GitHub Readme Streak Stats

- Display your total contributions, current streak, -
- and longest streak on your GitHub profile README + GitHub Readme Streak Stats Logo

+

Display your contribution streaks on your GitHub profile

+

@@ -16,242 +13,194 @@

-## ⚡ Quick setup - -1. Copy-paste the markdown below into your GitHub profile README -2. Replace the value after `?user=` with your GitHub username - -```md -[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1)](https://git.io/streak-stats) -``` - -3. Star the repo 😄 +## 📋 Table of Contents +- [Quick Setup](#-quick-setup) +- [Demo Site](#-demo-site) +- [Customization Options](#-customization-options) + - [Themes](#-themes) + - [Locales](#-locales) + - [Date Formats](#-date-formats) +- [How Stats Are Calculated](#ℹ️-how-these-stats-are-calculated) +- [Deployment Options](#-deployment-options) + - [Vercel (Recommended)](#deploy-to-vercel) + - [Heroku](#deploy-on-heroku) + - [Self-hosting](#deploy-on-your-own) +- [Contributing](#-contributing) +- [Support](#-support) + +## ⚡ Quick Setup + +1. Copy this markdown to your GitHub profile README: + ```md + [![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1)](https://git.io/streak-stats) + ``` +2. Replace `DenverCoder1` with your GitHub username +3. Star the repo! 😄 ### Next Steps -- Check out the [Demo Site](https://streak-stats.demolab.com) or [Options](https://github.com/DenverCoder1/github-readme-streak-stats?tab=readme-ov-file#-options) below for available customizations. - -- It is recommended to self-host the project more better reliability. See [Deploying it on your own](https://github.com/DenverCoder1/github-readme-streak-stats?tab=readme-ov-file#-deploying-it-on-your-own) for more details. +- Explore the [Demo Site](https://streak-stats.demolab.com) for customization options +- Self-host for better reliability (see [Deployment Options](#-deployment-options)) -[![][hspace]](#) [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)][herokudeploy] [![Deploy to Vercel](https://i.imgur.com/Mb3VLCi.png)][verceldeploy] +[![][hspace]](#) [![Deploy to Vercel](https://i.imgur.com/Mb3VLCi.png)][verceldeploy] [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)][herokudeploy] ## ⚙ Demo Site -Here you can customize your Streak Stats card with a live preview. - - - -[![Demo Site](https://user-images.githubusercontent.com/20955511/114579753-dbac8780-9c86-11eb-97dd-207039f67d20.gif "Demo Site")](http://streak-stats.demolab.com/demo/) - -## 🔧 Options - -The `user` field is the only required option. All other fields are optional. - -If the `theme` parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values. - -| Parameter | Details | Example | -| :------------------------: | :----------------------------------------------: | :------------------------------------------------------------------------------------------------: | -| `user` | GitHub username to show stats for | `DenverCoder1` | -| `theme` | The theme to apply (Default: `default`) | `dark`, `radical`, etc. [🎨➜](./docs/themes.md) | -| `hide_border` | Make the border transparent (Default: `false`) | `true` or `false` | -| `border_radius` | Set the roundness of the edges (Default: `4.5`) | Number `0` (sharp corners) to `248` (ellipse) | -| `background` | Background color (eg. `f2f2f2`, `35,d22,00f`) | **hex code** without `#`, **css color**, or gradient in the form `angle,start_color,...,end_color` | -| `border` | Border color | **hex code** without `#` or **css color** | -| `stroke` | Stroke line color between sections | **hex code** without `#` or **css color** | -| `ring` | Color of the ring around the current streak | **hex code** without `#` or **css color** | -| `fire` | Color of the fire in the ring | **hex code** without `#` or **css color** | -| `currStreakNum` | Current streak number | **hex code** without `#` or **css color** | -| `sideNums` | Total and longest streak numbers | **hex code** without `#` or **css color** | -| `currStreakLabel` | Current streak label | **hex code** without `#` or **css color** | -| `sideLabels` | Total and longest streak labels | **hex code** without `#` or **css color** | -| `dates` | Date range text color | **hex code** without `#` or **css color** | -| `excludeDaysLabel` | Excluded days of the week text color | **hex code** without `#` or **css color** | -| `date_format` | Date format pattern or empty for locale format | See note below on [📅 Date Formats](#-date-formats) | -| `locale` | Locale for labels and numbers (Default: `en`) | ISO 639-1 code - See [🗪 Locales](#-locales) | -| `short_numbers` | Use short numbers (e.g. 1.5k instead of 1,500) | `true` or `false` | -| `type` | Output format (Default: `svg`) | Current options: `svg`, `png` or `json` | -| `mode` | Streak mode (Default: `daily`) | `daily` (contribute daily) or `weekly` (contribute once per Sun-Sat week) | -| `exclude_days` | List of days of the week to exclude from streaks | Comma-separated list of day abbreviations (Sun, Mon, Tue, Wed, Thu, Fri, Sat) e.g. `Sun,Sat` | -| `disable_animations` | Disable SVG animations (Default: `false`) | `true` or `false` | -| `card_width` | Width of the card in pixels (Default: `495`) | Positive integer, minimum width is 100px per column | -| `card_height` | Height of the card in pixels (Default: `195`) | Positive integer, minimum height is 170px | -| `hide_total_contributions` | Hide the total contributions (Default: `false`) | `true` or `false` | -| `hide_current_streak` | Hide the current streak (Default: `false`) | `true` or `false` | -| `hide_longest_streak` | Hide the longest streak (Default: `false`) | `true` or `false` | -| `starting_year` | Starting year of contributions | Integer, must be `2005` or later, eg. `2017`. By default, your account creation year is used. | +Customize your Streak Stats card with an interactive preview at: + +**[streak-stats.demolab.com](https://streak-stats.demolab.com)** + +![Demo Site](https://user-images.githubusercontent.com/20955511/114579753-dbac8780-9c86-11eb-97dd-207039f67d20.gif "Demo Site") + +## 🔧 Customization Options + +The `user` parameter is the only required field. All other parameters are optional. + +> **Note**: When using the `theme` parameter, any custom colors will override the theme's defaults. + +| Parameter | Description | Example | +|:--------:|:-----------:|:-------:| +| `user` | GitHub username | `DenverCoder1` | +| `theme` | Stats card theme | `dark`, `radical`, etc. [🎨 View all themes](./docs/themes.md) | +| `hide_border` | Hide the border | `true` or `false` | +| `border_radius` | Corner roundness | `0` (sharp) to `248` (ellipse) | +| `background` | Background color | Hex code, CSS color, or gradient | +| `border` | Border color | Hex code or CSS color | +| `stroke` | Stroke line color | Hex code or CSS color | +| `ring` | Current streak ring color | Hex code or CSS color | +| `fire` | Fire icon color | Hex code or CSS color | +| `currStreakNum` | Current streak number color | Hex code or CSS color | +| `sideNums` | Total/longest streak number color | Hex code or CSS color | +| `currStreakLabel` | Current streak label color | Hex code or CSS color | +| `sideLabels` | Total/longest streak label color | Hex code or CSS color | +| `dates` | Date range text color | Hex code or CSS color | +| `excludeDaysLabel` | Excluded days color | Hex code or CSS color | +| `date_format` | Date format pattern | See [Date Formats](#-date-formats) | +| `locale` | Language for labels & numbers | ISO code - See [Locales](#-locales) | +| `short_numbers` | Use abbreviated numbers | `true` or `false` | +| `type` | Output format | `svg`, `png`, or `json` | +| `mode` | Streak calculation mode | `daily` or `weekly` | +| `exclude_days` | Days to exclude from streaks | e.g., `Sun,Sat` | +| `disable_animations` | Turn off animations | `true` or `false` | +| `card_width` | Width in pixels | Min: `100px` per column | +| `card_height` | Height in pixels | Min: `170px` | +| `hide_total_contributions` | Hide total contributions | `true` or `false` | +| `hide_current_streak` | Hide current streak | `true` or `false` | +| `hide_longest_streak` | Hide longest streak | `true` or `false` | +| `starting_year` | Starting year for contributions | `2005` or later | ### 🖌 Themes -To enable a theme, append `&theme=` followed by the theme name to the end of the source URL: +Add `&theme=` followed by the theme name to use a pre-designed color scheme: ```md [![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1&theme=dark)](https://git.io/streak-stats) ``` -| Theme | Preview | -| :------------: | :-----------------------------------------------------------: | -| `default` | ![default](https://i.imgur.com/IaTuYdS.png) | -| `dark` | ![dark](https://i.imgur.com/bUrsjlp.png) | -| `highcontrast` | ![highcontrast](https://i.imgur.com/ovrVrTY.png) | -| More themes! | **🎨 [See a list of all available themes](./docs/themes.md)** | - -**If you have come up with a new theme you'd like to share with others, please see [Issue #32](https://github.com/DenverCoder1/github-readme-streak-stats/issues/32) for more information on how to contribute.** - -### 🗪 Locales +**Popular themes:** +- `default` +- `dark` +- `highcontrast` -The following are the locales that have labels translated in Streak Stats. The `locale` query parameter accepts any ISO language or locale code, see [here](https://gist.github.com/DenverCoder1/f61147ba26bfcf7c3bf605af7d3382d5) for a list of valid locales. The locale provided will be used for the date format and number format even if translations are not yet available. +**[View all available themes](./docs/themes.md)** - - - -
en - English
English 100%		am - አማርኛ
አማርኛ 100%		ar - العربية
العربية 100%		bho - भोजपुरी
भोजपुरी 100%		bn - বাংলা
বাংলা 100%
ca - català
català 100%		ceb - Cebuano
Cebuano 100%		da - dansk
dansk 100%		de - Deutsch
Deutsch 100%		el - Ελληνικά
Ελληνικά 100%
es - español
español 100%		fa - فارسی
فارسی 100%		fil - Filipino
Filipino 100%		fr - français
français 100%		gu - ગુજરાતી
ગુજરાતી 100%
he - עברית
עברית 100%		hi - हिन्दी
हिन्दी 100%		hu - magyar
magyar 100%		id - Indonesia
Indonesia 100%		it - italiano
italiano 100%
ja - 日本語
日本語 100%		jv - Jawa
Jawa 100%		kn - ಕನ್ನಡ
ಕನ್ನಡ 100%		ko - 한국어
한국어 100%		mr - मराठी
मराठी 100%
ms - Melayu
Melayu 100%		my - မြန်မာ
မြန်မာ 100%		ne - नेपाली
नेपाली 100%		nl - Nederlands
Nederlands 100%		no - norsk
norsk 100%
pl - polski
polski 100%		ps - پښتو
پښتو 100%		pt_BR - português (Brasil)
português (Brasil) 100%		ru - русский
русский 100%		sa - संस्कृत भाषा
संस्कृत भाषा 100%
sd_PK - سنڌي (پاڪستان)
سنڌي (پاڪستان) 100%		sr - српски
српски 100%		su - Basa Sunda
Basa Sunda 100%		sw - Kiswahili
Kiswahili 100%		th - ไทย
ไทย 100%
tr - Türkçe
Türkçe 100%		uk - українська
українська 100%		ur_PK - اردو (پاکستان)
اردو (پاکستان) 100%		vi - Tiếng Việt
Tiếng Việt 100%		yo - Èdè Yorùbá
Èdè Yorùbá 100%
zh_Hans - 中文（简体）
中文（简体） 100%		zh_Hant - 中文（繁體）
中文（繁體） 100%		bg - български
български 86%		ht - créole haïtien
créole haïtien 86%		hy - հայերեն
հայերեն 86%
rw - Kinyarwanda
Kinyarwanda 86%		sv - svenska
svenska 86%		ta - தமிழ்
தமிழ் 86%
- - +Want to create a theme? See [Issue #32](https://github.com/DenverCoder1/github-readme-streak-stats/issues/32) for contribution guidelines. -**If you would like to help translate the Streak Stats cards, please see [Issue #236](https://github.com/DenverCoder1/github-readme-streak-stats/issues/236) for more information.** - -### 📅 Date Formats - -If `date_format` is not provided or is empty, the PHP Intl library is used to determine the date format based on the locale specified in the `locale` query parameter. - -A custom date format can be specified by passing a string to the `date_format` parameter. - -The required format is to use format string characters from [PHP's date function](https://www.php.net/manual/en/datetime.format.php) with brackets around the part representing the year. - -When the contribution year is equal to the current year, the characters in brackets will be omitted. - -**Examples:** - -| Date Format | Result | -| :-----------------: | :-----------------------------------------------------------------------------: | -| 
d F[, Y]
| 
"2020-04-14" => "14 April, 2020"

"2024-04-14" => "14 April"
| -| 
j/n/Y
| 
"2020-04-14" => "14/4/2020"

"2024-04-14" => "14/4/2024"
| -| 
[Y.]n.j
| 
"2020-04-14" => "2020.4.14"

"2024-04-14" => "4.14"
| -| 
M j[, Y]
| 
"2020-04-14" => "Apr 14, 2020"

"2024-04-14" => "Apr 14"
| +### 🗪 Locales -### Example +Set the `locale` parameter to display labels in your preferred language: ```md -[![GitHub Streak](https://streak-stats.demolab.com/?user=denvercoder1&currStreakNum=2FD3EB&fire=pink&sideLabels=F00&date_format=[Y.]n.j)](https://git.io/streak-stats) +[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1&locale=fr)](https://git.io/streak-stats) ``` -## ℹ️ How these stats are calculated - -This tool uses the contribution graphs on your GitHub profile to calculate which days you have contributed. +Currently supporting 50+ languages including English, Spanish, German, French, Japanese, Chinese, and many more. -To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page. +To help translate Streak Stats into more languages, see [Issue #236](https://github.com/DenverCoder1/github-readme-streak-stats/issues/236). -Contributions include commits, pull requests, and issues that you create in standalone repositories. +### 📅 Date Formats -The longest streak is the highest number of consecutive days on which you have made at least one contribution. +Customize how dates are displayed with the `date_format` parameter: -The current streak is the number of consecutive days ending with the current day on which you have made at least one contribution. If you have made a contribution today, it will be counted towards the current streak, however, if you have not made a contribution today, the streak will only count days before today so that your streak will not be zero. +```md +[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1&date_format=M%20j%5B,%20Y%5D)](https://git.io/streak-stats) +``` -> [!NOTE] -> You may need to wait up to 24 hours for new contributions to show up ([Learn how contributions are counted](https://docs.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile)) +The format uses [PHP's date format](https://www.php.net/manual/en/datetime.format.php) with brackets around the year part, which will be omitted when showing the current year. -## 📤 Deploying it on your own +**Examples:** +- `d F[, Y]` → "14 April, 2020" or "14 April" (current year) +- `j/n/Y` → "14/4/2020" or "14/4/2024" +- `[Y.]n.j` → "2020.4.14" or "4.14" (current year) +- `M j[, Y]` → "Apr 14, 2020" or "Apr 14" (current year) -It is preferable to host the files on your own server and it takes less than 2 minutes to set up. +## ℹ️ How These Stats Are Calculated -Doing this can lead to better uptime and more control over customization (you can modify the code for your usage). +- **Data Source**: Your GitHub profile's contribution graph +- **Private Contributions**: Included if enabled in your GitHub profile settings +- **Contribution Types**: Commits, pull requests, and issues in standalone repos +- **Longest Streak**: Highest number of consecutive days with at least one contribution +- **Current Streak**: Consecutive days with contributions ending with the current day -You can deploy the PHP files on any website server with PHP installed including Heroku and Vercel. +> **Note**: New contributions may take up to 24 hours to appear ([Learn how GitHub counts contributions](https://docs.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile)) -The Inkscape dependency is required for PNG rendering, as well as Segoe UI font for the intended rendering. If using Heroku, the buildpacks will install these for you automatically. +## 📤 Deployment Options -### [![Deploy to Vercel](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/5a503e6b-c462-4627-82ee-651f2cb2a1fc)][verceldeploy] +Self-hosting is recommended for better uptime and customization control. -Vercel is the recommended option for hosting the files since it is **free** and easy to set up. Watch the video below or expand the instructions to learn how to deploy to Vercel. +### Deploy to Vercel -> [!NOTE] -> PNG mode is not supported since Inkscape will not be installed but the default SVG mode will work. +[![Deploy to Vercel](https://i.imgur.com/Mb3VLCi.png)][verceldeploy] -### 📺 [Click here for a video tutorial on how to self-host on Vercel](https://www.youtube.com/watch?v=maoXtlb8t44) +**Recommended** - Free and easy setup, SVG mode only (no PNG support)
- Instructions for deploying to Vercel (Free) - -### Step-by-step instructions for deploying to Vercel - -#### Option 1: Deploy to Vercel quickly with the Deploy button (recommended) - -1. Click the Deploy button below - -[![][hspace]](#) [![Deploy with Vercel](https://i.imgur.com/Mb3VLCi.png)][verceldeploy] - -2. Create your repository by filling in a Repository Name and clicking "Create" -3. Visit [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) to create a new Personal Access Token (no scopes required) -4. Scroll to the bottom and click **"Generate token"** -5. **Add the token** as a Config Var with the key `TOKEN`: - -![vercel environment variables](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 of your app or continue to the dashboard to find your domain to use in place of `streak-stats.demolab.com` - -![deployment](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/32092461-5983-4fed-b21b-29be55ed85e8) - -> ⚠️ **Note** -> If you receive an error related to libssl or Node 20.x, you can fix this by opening your Vercel project settings and changing the Node.js version to 18.x. -> -> ![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/5fb18fb5-debe-4620-9c8b-193ab442a617) - -#### Option 2: Deploy to Vercel manually - -1. Sign in to **Vercel** or create a new account at -2. Use the following command to clone the repository: `git clone https://github.com/DenverCoder1/github-readme-streak-stats.git`. If you plan to make changes, you can also fork the repository and clone your fork instead. If you do not have Git installed, you can download it from . -3. Navigate to the cloned repository's directory using the command `cd github-readme-streak-stats` -4. Switch to the "vercel" branch using the command `git checkout vercel` -5. Make sure you have the Vercel CLI (Command Line Interface) installed on your system. If not, you can download it from . -6. Run the command `vercel` and follow the prompts to link your Vercel account and choose a project name -7. After successful deployment, your app will be available at `.vercel.app` -8. Open [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) to create a new Personal Access Token on GitHub. You don't need to select any scopes for the token. -9. Scroll to the bottom of the page and click on **"Generate token"** -10. Visit the Vercel dashboard at and select your project. Then, click on **"Settings"** and choose **"Environment Variables"**. -11. Add a new environment variable with the key `TOKEN` and the value as the token you generated in step 9, then save your changes -12. To apply the new environment variable, you need to redeploy the app. Run `vercel --prod` to deploy the app to production. - -![image](https://user-images.githubusercontent.com/20955511/209588756-8bf5b0cd-9aa6-41e8-909c-97bf41e525b3.png) - -> ⚠️ **Note** -> To set up automatic Vercel deployments from GitHub, make sure to turn **off** "Include source files outside of the Root Directory" in the General settings and use `vercel` as the production branch in the Git settings. - -> ⚠️ **Note** -> If you receive an error related to libssl or Node 20.x, you can fix this by opening your Vercel project settings and changing the Node.js version to 18.x. -> -> ![image](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/5fb18fb5-debe-4620-9c8b-193ab442a617) + Step-by-step Vercel deployment instructions + +#### Quick Deploy (Recommended) +1. Click the [Deploy to Vercel][verceldeploy] button +2. Create a repository name and click "Create" +3. Create a [GitHub Personal Access Token](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) (no scopes needed) +4. Add the token as a Config Var named `TOKEN` +5. Click "Deploy" +6. Use your domain (e.g., `your-app.vercel.app`) instead of `streak-stats.demolab.com` + +> ⚠️ If you get libssl or Node 20.x errors, change the Node.js version to 18.x in your Vercel project settings. + +#### Manual Deploy +1. Sign in to [Vercel](https://vercel.com) or create an account +2. Clone the repository: `git clone https://github.com/DenverCoder1/github-readme-streak-stats.git` +3. Navigate to the directory: `cd github-readme-streak-stats` +4. Switch to the Vercel branch: `git checkout vercel` +5. Install the [Vercel CLI](https://vercel.com/download) +6. Run `vercel` and follow the prompts +7. Create a [GitHub Personal Access Token](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) +8. Add the token as an environment variable named `TOKEN` in your Vercel project settings +9. Run `vercel --prod` to deploy to production
-### [![Deploy on Heroku](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/e8b575af-5746-4200-a295-7e7baa448383)][herokudeploy] +### Deploy on Heroku -Heroku is another great option for hosting the files. All features are supported on Heroku and it is where the default domain is hosted. Heroku is not free, however, and you will need to pay between \$5 and \$7 per month to keep the app running. Expand the instructions below to learn how to deploy to Heroku. +[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)][herokudeploy] -
- Instructions for deploying to Heroku (Paid) - -### 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 - -[![][hspace]](#) [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)][herokudeploy] - -5. **Add the token** as a Config Var with the key `TOKEN`: +Full-featured but requires a paid plan ($5-7/month) -![heroku config variables](https://user-images.githubusercontent.com/20955511/136292022-a8d9b3b5-d7d8-4a5e-a049-8d23b51ce9d7.png) +
+ Step-by-step Heroku deployment instructions -6. Click **"Deploy App"** at the end of the form -7. Once the app is deployed, you can use `.herokuapp.com` in place of `streak-stats.demolab.com` +1. Sign in to [Heroku](https://heroku.com) or create an account +2. Create a [GitHub Personal Access Token](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Streak%20Stats) +3. Click the [Deploy to Heroku][herokudeploy] button +4. Add your token as a Config Var named `TOKEN` +5. Click "Deploy App" +6. Use your app name (e.g., `your-app.herokuapp.com`) instead of `streak-stats.demolab.com`
-### ![Deploy on your own](https://github.com/DenverCoder1/github-readme-streak-stats/assets/20955511/e36ed842-ab56-473a-83fd-ace5bf968996) +### Deploy on Your Own -You can transfer the files to any webserver using FTP or other means, then refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for installation steps. +Transfer files to any web server with PHP support. See [CONTRIBUTING.md](/CONTRIBUTING.md) for installation requirements. [hspace]: https://user-images.githubusercontent.com/20955511/136058102-b79570bc-4912-4369-b664-064a0ada8588.png [verceldeploy]: 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 @@ -259,11 +208,11 @@ You can transfer the files to any webserver using FTP or other means, then refer ## 🤗 Contributing -Contributions are welcome! Feel free to [open an issue](https://github.com/DenverCoder1/github-readme-streak-stats/issues/new/choose) or submit a [pull request](https://github.com/DenverCoder1/github-readme-streak-stats/compare) if you have a way to improve this project. - -Make sure your request is meaningful and you have tested the app locally before submitting a pull request. +Contributions are welcome! Please: +- [Open an issue](https://github.com/DenverCoder1/github-readme-streak-stats/issues/new/choose) for bugs or feature requests +- [Submit a pull request](https://github.com/DenverCoder1/github-readme-streak-stats/compare) with improvements -Refer to [CONTRIBUTING.md](/CONTRIBUTING.md) for more details on contributing, installing requirements, and running the application. +Check [CONTRIBUTING.md](/CONTRIBUTING.md) for detailed guidance on requirements and local setup. ## 🙋‍♂️ Support