diff --git a/README.md b/README.md index 51f8e3f..8869abc 100644 --- a/README.md +++ b/README.md @@ -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'; ``` -# 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)*