From ec515571e549620f5bb73f5e70a119d56a0f3fa7 Mon Sep 17 00:00:00 2001 From: Fascinated Date: Wed, 12 Jul 2023 09:55:09 +0100 Subject: [PATCH] update readme --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2a4c5a0..065239a 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,16 @@ Simple Links is a lightweight alternative to Linktree and others. Just simply remove it from the config and it will not show anymore +## Help!!! I'm getting an error when launching it + +### Config Issue + +If your error looks similar to this you are most likely missing part of the config, as some new things may have been added. + +```bash +simple-links | Type error: Property 'theme' does not exist on type '{ name: string; description: string; avatar: string; background: { showBackground: boolean; blur: boolean; darken: { enabled: boolean; amount: number; }; backgroundImage: string; }; infoCard: { transparency: number; }; metadata: { ...; }; options: { ...; }; analytics: { ...; }; links: { ...; }[]; }'. +``` + ## Config Example ```json @@ -117,13 +127,3 @@ Just simply remove it from the config and it will not show anymore ] } ``` - -## Help!!! I'm getting an error when launching it - -### Config Issue - -If your error looks similar to this you are most likely missing part of the config, as some new things may have been added. - -```bash -simple-links | Type error: Property 'theme' does not exist on type '{ name: string; description: string; avatar: string; background: { showBackground: boolean; blur: boolean; darken: { enabled: boolean; amount: number; }; backgroundImage: string; }; infoCard: { transparency: number; }; metadata: { ...; }; options: { ...; }; analytics: { ...; }; links: { ...; }[]; }'. -```