37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# Astro GitHub Stats ✨
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://www.npmjs.com/package/astro-github-stats)
|
|
[](https://github.com/ayoayco/astro-github-stats)
|
|
|
|
Embed GitHub stats on your [Astro](https://astro.build) page ✨
|
|
|
|
|
|
|
|
**Demo:** [https://ayco.io/showcase/astro-github-stats](https://ayco.io/showcase/astro-github-stats)
|
|
|
|
*Please report issues found or suggestions in the [project issues page](https://github.com/ayoayco/astro-github-stats/issues)*
|
|
|
|
### Usage
|
|
Install on your Astro project:
|
|
|
|
```
|
|
npm i astro-github-stats
|
|
```
|
|
|
|
Then use on your Astro page:
|
|
|
|
```astro
|
|
---
|
|
import GithubStats from 'astro-github-stats';
|
|
---
|
|
<GithubStats username="ayoayco" />
|
|
```
|
|
|
|
### Future plans
|
|
Initially this is a wrapper for [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) supporting the basic github account stats card. Other features can be supported later, depending on demand:
|
|
1. repo cards
|
|
1. themes
|
|
1. account top languages
|
|
|
|
*Please report issues found or suggestions in the [project issues page](https://github.com/ayoayco/astro-github-stats/issues)*
|