Update Readme (#1)

agonyz · Jul 13, 2023 · 296117e · 296117e
1 parent 40ca02e
commit 296117e
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 15 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1 +1,3 @@
-dist/
+dist/
+docs/
+
diff --git a/.prettierignore b/.prettierignore
@@ -1 +1,2 @@
-dist/
+dist/
+docs/
diff --git a/README.md b/README.md
@@ -1,5 +1,17 @@
-## GitHub Readme Packagist Stats
-Get dynamically generated stats for your top packagist bundles
+<div align="center">
+  <img alt="Packagist Logo" src="docs/packagist.svg" width="100" align="center">
+  <h1>GitHub Readme Packagist Stats</h1>
+
+[![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)
+
+</div>
+
+<p align="center">
+  Get dynamically generated statistics for your Packagist Bundles
+</p>
+
 
 ## Features
 - [Top bundles](#top-bundles)
@@ -9,23 +21,27 @@ 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)
   ```
   ![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.
diff --git a/docs/packagist.svg b/docs/packagist.svg
diff --git 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
@@ -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;