ayo/astro-github-stats
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update readme

Browse source
This commit is contained in:
Ayo 2022-09-29 21:12:11 +02:00
parent 5c0e04c6c2
commit 94bd112ac9
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -10,6 +10,7 @@ Embed GitHub stats on your [Astro](https://astro.build) page ✨
Features: Features:
1. Embed GitHub Account stats 1. Embed GitHub Account stats
1. Embed GitHub Account top languages
1. Embed GitHub Repositories info with stars 1. Embed GitHub Repositories info with stars
# Insatllation # Insatllation
@ -30,6 +31,9 @@ import GithubStats from 'astro-github-stats';
<!-- Add your account stats --> <!-- Add your account stats -->
<GithubStats username="ayoayco" /> <GithubStats username="ayoayco" />
<!-- Add your account stats -->
<GithubStats username="ayoayco" topLanguages={true} />
<!-- Add a repo card with info and stars --> <!-- Add a repo card with info and stars -->
<GithubStats username="withastro" repo="astro" /> <GithubStats username="withastro" repo="astro" />
``` ```
@ -40,6 +44,10 @@ Example Account Card:
![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png) ![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png)
Example Account Top Languages:
<img width="312" alt="Screen Shot 2022-09-29 at 9 09 05 PM" src="https://user-images.githubusercontent.com/4262489/193121588-9737c861-d08a-4103-9d9b-11bcd0c7c713.png">
Example Repo Card: Example Repo Card:
![Screen Shot 2022-09-27 at 3 51 15 PM](https://user-images.githubusercontent.com/4262489/192545079-c602944c-6843-427a-b810-832973e6782c.png) ![Screen Shot 2022-09-27 at 3 51 15 PM](https://user-images.githubusercontent.com/4262489/192545079-c602944c-6843-427a-b810-832973e6782c.png)