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

update project readme

Browse source
This commit is contained in:
Ayo 2022-09-24 22:21:30 +02:00
parent 353b3ec54b
commit 3a9643b7af
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,20 +1,23 @@
# 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 in your Astro page ✨
Embed github stats on your [Astro](https://astro.build) page ✨
# Usage
![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png)
Install in use in your Astro project:
*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 in your Astro page:
Then use on your Astro page:
```
---
@ -23,13 +26,10 @@ import GithubStats from 'astro-github-stats';
<GithubStats username="ayoayco" />
```
# Showcase
![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png)
# Future plans
This is a wrapper for [github-readme-stats](https://github.com/anuraghazra/github-readme-stats). Other features will be supported later:
1. repo stats card
### 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)*