Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vaporvee authored Jun 29, 2024
1 parent a8cc8fd commit 9ff256d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# GithubCard from astro-github-component

<img src="https://github.com/vaporvee/astro-github-component/assets/80621863/f3c23641-0e1e-4bb2-8d2f-ee55ffbf615e" width="300">
<br><br>
Adds a component to astro with statically built GitHub info and dynamic updated stars and forks. <br/>
Supports GitHub auth tokens in the built process (use a .env for example) and dynamic stars/forks caching to manage the GitHub API rate limiting. <br/>
More features/fixes will follow.
More features/fixes will follow. <br>
<br>

```sh
npm i astro-github-component
```

![grafic](https://github.com/vaporvee/astro-github-component/assets/80621863/2ade5799-055c-419c-b6af-997a2bb337df)
![grafic](https://github.com/vaporvee/astro-github-component/assets/80621863/2ade5799-055c-419c-b6af-997a2bb337df)

0 comments on commit 9ff256d

Please sign in to comment.