astro-github-stats/README.md
2022-09-24 22:21:30 +02:00

35 lines
1.4 KiB
Markdown

# Astro Github Stats
[![npm](https://img.shields.io/npm/v/astro-github-stats)](https://www.npmjs.com/package/astro-github-stats)
[![npm](https://img.shields.io/npm/l/astro-github-stats)](https://www.npmjs.com/package/astro-github-stats)
[![npm](https://img.shields.io/npm/dt/astro-github-stats)](https://www.npmjs.com/package/astro-github-stats)
[![github](https://img.shields.io/github/last-commit/ayoayco/astro-github-stats)](https://github.com/ayoayco/astro-github-stats)
Embed github stats on your [Astro](https://astro.build) page ✨
![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png)
*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:
```
---
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)*