From 296117ed7f928beeca494d3bf189f29b418c7fed Mon Sep 17 00:00:00 2001 From: agonyz <71080150+agonyz@users.noreply.github.com> Date: Thu, 13 Jul 2023 20:33:52 +0200 Subject: [PATCH] Update Readme (#1) --- .eslintignore | 4 +++- .prettierignore | 3 ++- README.md | 32 ++++++++++++++++++++++++-------- docs/packagist.svg | 1 + package.json | 2 +- src/styles/card.ts | 4 ---- 6 files changed, 31 insertions(+), 15 deletions(-) create mode 100644 docs/packagist.svg diff --git a/.eslintignore b/.eslintignore index 7773828..3dd54a9 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1 +1,3 @@ -dist/ \ No newline at end of file +dist/ +docs/ + diff --git a/.prettierignore b/.prettierignore index 7773828..6d56539 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,2 @@ -dist/ \ No newline at end of file +dist/ +docs/ \ No newline at end of file diff --git a/README.md b/README.md index a746f89..41aa630 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -## GitHub Readme Packagist Stats -Get dynamically generated stats for your top packagist bundles +
+ Packagist Logo +

GitHub Readme Packagist Stats

+ +[![Badge](https://img.shields.io/github/issues/agonyz/github-readme-packagist-stats?style=for-the-badge)](https://github.com/agonyz/github-readme-packagist-stats/issues) +[![Badge](https://img.shields.io/github/issues-pr/agonyz/github-readme-packagist-stats?style=for-the-badge)](https://github.com/agonyz/github-readme-packagist-stats/pulls) +[![Badge](https://img.shields.io/github/stars/agonyz/github-readme-packagist-stats?style=for-the-badge)](https://github.com/agonyz/github-readme-packagist-stats/stargazers) + +
+ +

+ Get dynamically generated statistics for your Packagist Bundles +

+ ## Features - [Top bundles](#top-bundles) @@ -9,9 +21,11 @@ Get dynamically generated stats for your top packagist bundles ## Top bundles ### By vendor -- Retrieves the top bundles for the given vendor +Retrieves the top bundles for the given vendor - How to use: - - https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor={your-packagist-user} + ```markdown + /api/packagist/card?vendor={your-packagist-user} + ``` - Example: ```markdown ![Packagist Top Bundles](https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor=agonyz) @@ -19,13 +33,15 @@ Get dynamically generated stats for your top packagist bundles ![Packagist Top Bundles](https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor=agonyz) ### By maintainer -- Retrieves the top bundles for the given maintainer from the given vendor +Retrieves the top bundles for the given maintainer from the given vendor - How to use: - - https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor={your-example-organization}&maintainer={your-packagist-user} + ```markdown + /api/packagist/card?vendor={your-example-organization}&maintainer={your-packagist-user} + ``` - Example: ```markdown - ![Packagist Top Bundles](https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor={your-example-organization}&maintainer={your-packagist-user}) + ![Packagist Top Bundles](https://github-readme-packagist-stats.vercel.app/api/packagist/card?vendor=exampleOrganization&maintainer=agonyz) ``` - + ## Caching - In order to not overuse the packagist api a cache time of `12 hours` was implemented. \ No newline at end of file diff --git a/docs/packagist.svg b/docs/packagist.svg new file mode 100644 index 0000000..e1b6db7 --- /dev/null +++ b/docs/packagist.svg @@ -0,0 +1 @@ +Packagist \ No newline at end of file diff --git a/package.json b/package.json index f626b09..4615618 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "github-readme-packagist-stats", - "version": "1.0.0", + "version": "1.0.1", "description": "", "main": "dist/index.js", "scripts": { diff --git a/src/styles/card.ts b/src/styles/card.ts index 7c4d577..d3d6f9d 100644 --- a/src/styles/card.ts +++ b/src/styles/card.ts @@ -19,10 +19,6 @@ export const cardCss = ` font-style: italic; font-weight: 500; } -#avatar { - font-size: 45px; - font-family: virgil; -} .bundle-card { fill: #fff; stroke: #b34e22;