diff --git a/README.md b/README.md index 23a698e..f9be1eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # 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) @@ -6,32 +7,48 @@ Embed GitHub stats on your [Astro](https://astro.build) page ✨ -![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png) +Features: -**Demo:** [https://ayco.io/showcase/astro-github-stats](https://ayco.io/showcase/astro-github-stats) +1. Embed GitHub Account stats +1. Embed GitHub Repositories info with stars -*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: +# Insatllation ``` npm i astro-github-stats ``` +# Usage + Then use on your Astro page: ```astro --- import GithubStats from 'astro-github-stats'; --- + + + + + ``` -### Future plans +# Screenshots + +Example Account Card: + +![screenshot](https://raw.githubusercontent.com/ayoayco/astro-github-stats/main/assets/screenshot.png) + +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) + +# 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)* +_Please report issues found or suggestions in the [project issues page](https://github.com/ayoayco/astro-github-stats/issues)_ diff --git a/package.json b/package.json index d1a1d04..08b390b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "astro-github-stats", - "description": "Embed github stats in your Astro page", + "description": "Embed GitHub stats in your Astro page ✨", "repository": "https://github.com/ayoayco/astro-github-stats", "homepage": "https://ayco.io/showcase/astro-github-stats", "version": "0.2.0",