Update README.md

This commit is contained in:
hazycora 2023-08-03 09:01:06 -05:00
parent cd97774fb2
commit d0c981881c
No known key found for this signature in database
GPG key ID: 215AF1F81F86940E

View file

@ -1,3 +1,11 @@
# og
git.gay's opengraph preview server, inspired by github's.
[git.gay](https://git.gay)'s thumbnail server, inspired by GitHub's.
![A demo thumbnail for this repository](https://og.git.gay/gitgay/og)
Made with [@besties/html2png](https://git.gay/besties/html2png), itself a wrapper for [satori](https://www.npmjs.com/package/satori) and [@resvg/resvg-wasm](https://www.npmjs.com/package/@resvg/resvg-wasm).
## Self-hosting
clone the repository, install the dependencies with `npm i`, create a `.env` file (see [.env.example](/.env.example)), and run `npm run start`.