From 6805a8bf48a20b82ad86d591de58cb01c5c26720 Mon Sep 17 00:00:00 2001 From: mickie Date: Fri, 21 Jan 2022 16:49:45 -0600 Subject: [PATCH] Update instances doc. --- src/lib/instances.ts | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/src/lib/instances.ts b/src/lib/instances.ts index 618d34e..b6660cf 100644 --- a/src/lib/instances.ts +++ b/src/lib/instances.ts @@ -1,17 +1,19 @@ /* - * ---------------------- The Fediverse ----------------------- + * ------------------------------- The Fediverse ------------------------------- + * * Properties: - * - name - - * + The name of the social network / service (instance). - * NO whitespaces! - * - post - - * + The HTTP POST request method. Important to include the - * Title and Url. - * - icon - - * + The icon to be displayed in the popup (main) window. - * Taken from Fork Awesome. - * - host - - * + The default host. + * - name + * The name of the social network / service (instance). NO whitespaces! + * + * - post + * The HTTP POST request method. Important: include the Title and Url. + * + * - icon + * The icon to be displayed in the popup (main) window. Taken from Fork + * Awesome. + * + * - host + * The default host (instance). * */ import { Instance } from './interface';