Add README.md to pages branch

This commit is contained in:
hazycora 2023-08-03 10:01:38 -05:00
commit 9ee85f23fc
No known key found for this signature in database
GPG key ID: 215AF1F81F86940E
2 changed files with 19 additions and 0 deletions

8
.gitignore vendored Normal file
View file

@ -0,0 +1,8 @@
node_modules/
.env
.env.*
!.env.example
# we're a pnpm household now
package-lock.json

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# og
[git.gay](https://git.gay)'s thumbnail server, inspired by GitHub's.
![A demo thumbnail for this repository, generated by this project](https://og.git.gay/gitgay/og?format=svg)
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](https://git.gay/gitgay/og/src/branch/main/.env.example)), and run `npm run start`.