Got any questions?
These should answer them all!

Easy Option

You can contact me on your discord with an image of your skin overlay and I will add your socials and name to the website!

Manual Option

1. Clone the repository $ git clone https://github.com/Cryptizism/skin-overlay.git
2. Clone the repository $ git clone https://github.com/Cryptizism/skin-overlay.git
3. Populate your file like below
   1. {
   2. "name":"Banana Hat",
   3. "description": "This banana hat was inspired by bananas", (optional)
   4. "pubDate": "Aug 01 2023", (optional)
   5. "author": "Cryptizism" (optional)
   6. }
4. Place the image of your skin overlay in public/overlays with the same name as your .json
5. Create a pull request

Basic Usage

1. Clone the repository $ git clone https://github.com/Cryptizism/skin-overlay.git

2. Install dependencies

   $ npm i

3. Run in development enviroment

   $ npm run dev

Deploying

1. Edit your astro.config.mjs to reflect your github repo like below

   1. import { defineConfig } from 'astro/config';
   2. import tailwind from "@astrojs/tailwind";
   4. export default defineConfig({
   5. integrations: [tailwind()],
   6. site: 'https://YOUR_ACCOUNT.github.io',
   7. site: '/your_repo',
   8. });
2. Under the settings page of your repo go to pages and turn the source to "GitHub Actions"