From 9ee85f23fcd63ff32cea92f6a6736aed5cc81963 Mon Sep 17 00:00:00 2001 From: hazycora Date: Thu, 3 Aug 2023 10:01:38 -0500 Subject: [PATCH] Add README.md to pages branch --- .gitignore | 8 ++++++++ README.md | 11 +++++++++++ 2 files changed, 19 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..56cda82 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +node_modules/ + +.env +.env.* +!.env.example + +# we're a pnpm household now +package-lock.json \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f98a3f6 --- /dev/null +++ b/README.md @@ -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`. \ No newline at end of file