From 77e2e3758b3cf8af77d057b8cb11612c425eb8f4 Mon Sep 17 00:00:00 2001 From: Domai Date: Tue, 13 Jun 2023 13:10:32 +0200 Subject: [PATCH] adjust readme --- README.md | 160 ++++++++++++++++----------------------------- assets/history.svg | 43 ++++++++++++ assets/profile.svg | 73 +++++++++++++++++++++ assets/toplang.svg | 31 +++++++++ 4 files changed, 204 insertions(+), 103 deletions(-) create mode 100644 assets/history.svg create mode 100644 assets/profile.svg create mode 100644 assets/toplang.svg diff --git a/README.md b/README.md index 55cedcd..0a2ae66 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@

- GitHub Readme Stats + GitHub Readme Stats

Code::Stats Readme

Get dynamically generated Code::Stats stats on your readmes!

# Features -- [Features](#features) - [Profile Card](#profile-card) - [History Card](#history-card) - [Top Languages Card](#top-languages-card) @@ -14,134 +13,89 @@ # Profile Card -Copy paste this into your markdown content, and that's it. Simple! +![](./assets/profile.svg) -Change the `?username=` value to your GitHub's username. +## Options -```md -[![Avior's code::stats stats](https://codestats-readme.avior.me/api?username=aviortheking)](https://github.com/Aviortheking/codestats-readme) -``` - -[![Avior's code::stats stats](https://codestats-readme.avior.me/api?username=aviortheking)](https://github.com/Aviortheking/codestats-readme) - -### Options - -| Option Name | Preview | Description | -| ----------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| hide | ![](https://codestats-readme.avior.me/api?username=aviortheking&hide=xp) | Hide specific line, ex: `&hide=xp` or `&hide=xp,recent_xp` | -| show_icons | ![](https://codestats-readme.avior.me/api?username=aviortheking&show_icons) | shows icons before each lines ex: `&show_icons` | -| hide_rank | ![](https://codestats-readme.avior.me/api?username=aviortheking&hide_rank) | hide the rank circle ex: `&hide_rank` | -| line_height | ![](https://codestats-readme.avior.me/api?username=aviortheking&line_height=45) | change the line Height of each lines, ex: `&line_height=45` | -| icon_color | ![](https://codestats-readme.avior.me/api?username=aviortheking&icon_color=123456&show_icons) | change the icons color, ex: `&icon_color=123456&show_icons` | -| text_color | ![](https://codestats-readme.avior.me/api?username=aviortheking&text_color=123456) | change the text colors, ex: `&text_color=123456` | +| Option Name | Description | +| ----------- | ----------------------------------------------------------- | +| hide | Hide specific line, eg: `&hide=xp` or `&hide=xp,recent_xp` | +| show_icons | Shows icons before each lines eg: `&show_icons` | +| hide_rank | Hide the rank circle eg: `&hide_rank` | +| line_height | Change the line Height of each lines, eg: `&line_height=45` | +| icon_color | Change the icons color, eg: `&icon_color=123456&show_icons` | +| text_color | Change the text colors, eg: `&text_color=123456` | # History Card -Shows your XP history as it's shown on your profile. +![](./assets/history.svg) -Copy-paste this code into your readme and change the links. +## Options -Endpoint: `api/history?username=Aviortheking` - -```md -[![History](https://codestats-readme.avior.me/api/history/?username=Aviortheking)](https://github.com/aviortheking/codestats-readme) -``` - -[![History](https://codestats-readme.avior.me/api/history/?username=Aviortheking)](https://github.com/aviortheking/codestats-readme) - -### Options - -| Option Name | Preview | Description | -| -------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| layout | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&layout=horizontal) | Change the layout to the horizontal one
ex: `&layout=horizontal` | -| height | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&height=400&layout=horizontal) | Change the height of the card _Only on horizontal layout_
ex: `&height=400`
Default: `300` | -| width | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&width=400) | Change the width of the card _Only on vertical layout_
ex: `&width=TypeScript`
Default: `500` | -| title | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&title=History) | Change the title of the card
ex: `&title=History` | -| days_count | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&days_count=7) | Change the number of days shown
ex: `&days_count=7` 
Default: `14` | -| reverse_order | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&reverse_order) | Reverse the order of the days
ex: `&reverse_order` | -| hide | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&hide=Typescript) | Hide specifics languages and put them in Others
ex: `&hide=TypeScript` | -| language_count | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&language_count=3) | Change the number of languages shown before going to Others
ex: `&language_count=3`
defaults: `8` | -| text_color | ![](https://codestats-readme.avior.me/api/history?username=Aviortheking&text_color=654321) | change the text colors
ex: `&text_color=654321` | +| Option Name | Description | +| -------------- | ----------------------------------------------------------------------------------------------------------- | +| layout | Change the layout to the horizontal one
ex: `&layout=horizontal` | +| height | Change the height of the card _Only on horizontal layout_
ex: `&height=400`
Default: `300` | +| width | Change the width of the card _Only on vertical layout_
ex: `&width=TypeScript`
Default: `500` | +| title | Change the title of the card
ex: `&title=History` | +| days_count | Change the number of days shown
ex: `&days_count=7` 
Default: `14` | +| reverse_order | Reverse the order of the days
ex: `&reverse_order` | +| hide | Hide specifics languages and put them in Others
ex: `&hide=TypeScript` | +| language_count | Change the number of languages shown before going to Others
ex: `&language_count=3`
defaults: `8` | +| text_color | Change the text colors
ex: `&text_color=654321` | # Top Languages Card -Top languages card shows user's top languages. +![](./assets/toplang.svg) -Copy-paste this code into your readme and change the links. +## Options -Endpoint: `api/top-langs?username=aviortheking` +| Option Name | Description | +| -------------- | ----------------------------------------------------------------------------------------------------------- | +| hide | Hide Specific language
ex: `&hide=TypeScript` or `&hide=TypeScript,TypeScript%20(JSX)` | +| language_count | Change the number of languages shown before going to Others
ex: `&language_count=3`
defaults: `8` | +| card_width | Hide the rank circle
ex: `&card_width=600`
defaults: `300` | +| layout | Make the layout more compact
ex: `&layout=compact` | +| text_color | Cange the text colors
ex: `&text_color=654321` | -```md -[![Top Langs](https://codestats-readme.avior.me/api/top-langs/?username=aviortheking)](https://github.com/aviortheking/codestats-readme) -``` - -[![Top Langs](https://codestats-readme.avior.me/api/top-langs/?username=aviortheking)](https://github.com/aviortheking/codestats-readme) - -### Options - -| Option Name | Preview | Description | -| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| hide | ![](https://codestats-readme.avior.me/api/top-langs?username=aviortheking&hide=TypeScript) | Hide Specific language
ex: `&hide=TypeScript` or `&hide=TypeScript,TypeScript%20(JSX)` | -| language_count | ![](https://codestats-readme.avior.me/api/top-langs?username=aviortheking&language_count=3) | Change the number of languages shown before going to Others
ex: `&language_count=3`
defaults: `8` | -| card_width | ![](https://codestats-readme.avior.me/api/top-langs?username=aviortheking&card_width=250) | hide the rank circle
ex: `&card_width=600`
defaults: `300` | -| layout | ![](https://codestats-readme.avior.me/api/top-langs?username=aviortheking&layout=compact) | make the layout more compact
ex: `&layout=compact` | -| text_color | ![](https://codestats-readme.avior.me/api/top-langs?username=aviortheking&text_color=654321) | change the text colors
ex: `&text_color=654321` | # Common Options -| Options Name | Preview | Description | -| ------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| title_color | ![](https://codestats-readme.avior.me/api?username=aviortheking&title_color=654321) | Change the title color
ex: `&title_color=654321` | -| bg_color | ![](https://codestats-readme.avior.me/api?username=aviortheking&bg_color=654321) | Change the background color
ex: `&bg_color=654321` | -| hide_border | ![](https://codestats-readme.avior.me/api?username=aviortheking&hide_border) | Hide the border
ex: `&hide_border` | -| hide_title | ![](https://codestats-readme.avior.me/api?username=aviortheking&hide_title) | Hide the title
ex: `&hide_border` | -| theme | ![](https://codestats-readme.avior.me/api?username=aviortheking&theme=radical) | See [#themes](Themes) | -| cache_seconds | ![](https://codestats-readme.avior.me/api?username=aviortheking&cache_seconds=86400) | set the cache header manually _(min: 1800, max: 86400)_
ex: `&cache_seconds=86400`
Default: `1800` or 30 minutes | +| Options Name | Description | +| ------------- | -------------------------------------------------------------------------------------------------------------------------- | +| title_color | Change the title color
ex: `&title_color=654321` | +| bg_color | Change the background color
ex: `&bg_color=654321` | +| hide_border | Hide the border
ex: `&hide_border` | +| hide_title | Hide the title
ex: `&hide_border` | +| theme | See [#themes](Themes) | +| cache_seconds | set the cache header manually _(min: 1800, max: 86400)_
ex: `&cache_seconds=86400`
Default: `1800` or 30 minutes | +| title | CHange the cards title. eg: `&title=My Code::Stats` | + +# Themes With inbuilt themes you can customize the look of the card without doing any [manual customization](#customization). Use `?theme=THEME_NAME` parameter like so :- -```md -![Aviortheking's Code::Stats stats](https://codestats-readme.avior.me/api?username=aviortheking&show_icons=true&theme=nightowl) -``` - -![Aviortheking's Code::Stats stats](https://codestats-readme.avior.me/api?username=aviortheking&show_icons=true&theme=nightowl) - -#### All inbuilt themes :- - dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula -You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D +You can checkout the [theme config file](./themes/index.js)! ---- +# Development -### Quick Tip (Align your Cards) +Both ways will create a webserver that listens on port 3000. -You usually won't be able to layout the images side by side. To do that you can use this approach: +## Docker -```md - - - - - - +```shell +docker build . --tag your-tag +docker run your-tag ``` -## Deploy on your own Server +## NPM - -
- -1. Build the Docker image `docker build . --tag your-tag` -2. run the Docker image `docker run your-tag` -3. Profit on the port 3000! - -
- ---- - -Contributions are welcomed! <3 - -Made with :heart: and Typescript. +```shell +npm ci +npm run build +npm run start +``` diff --git a/assets/history.svg b/assets/history.svg new file mode 100644 index 0000000..9c1f362 --- /dev/null +++ b/assets/history.svg @@ -0,0 +1,43 @@ +Last 14 days XP history819 XPMay30868 XPMay314460 XPJun01244 XPJun029257 XPJun03926 XPJun042559 XPJun053242 XPJun062308 XPJun070 XPJun09511 XPJun103526 XPJun117359 XPJun123312 XPJun13C#Terminal (Zsh)YAMLTypeScriptVuePythonMakefileMarkdownOther \ No newline at end of file diff --git a/assets/profile.svg b/assets/profile.svg new file mode 100644 index 0000000..da5234c --- /dev/null +++ b/assets/profile.svg @@ -0,0 +1,73 @@ +:Domai's Code::Statslv 18XP:551kRecent xp:3k \ No newline at end of file diff --git a/assets/toplang.svg b/assets/toplang.svg new file mode 100644 index 0000000..f0d7555 --- /dev/null +++ b/assets/toplang.svg @@ -0,0 +1,31 @@ +My LanguagesPython 26.09%Terminal (Zsh) 24.23%Dart 18.26%Markdown 8.5%C# 8.46%Vue 2.36%Makefile 1.78%YAML 1.62%HTML 1.55%JSON 1.4%CSS 1.22%TypeScript 0.77%Rust 0.9%Shell Script 0.73%LaTeX 0.73%TypeScript (JSX) 0.17%SVG 0.33%Git 0.22%XML 0.18%TOML 0.1%JavaScript 0.09%TeX 0.09%SCSS 0.07%C 0.06%CSV 0.03%Docker 0.02%Go 0.02%Groovy 0.01%PHP 0.01% \ No newline at end of file