From 1c7e1277e435eb4a806d1608227239eca0096ad8 Mon Sep 17 00:00:00 2001
From: Amelia Yukii <123300075+Insert5StarName@users.noreply.github.com>
Date: Fri, 8 Dec 2023 22:35:00 +0100
Subject: [PATCH] Update README.md

---
 README.md | 63 +------------------------------------------------------
 1 file changed, 1 insertion(+), 62 deletions(-)

diff --git a/README.md b/README.md
index 4ddb40c..2024eeb 100644
--- a/README.md
+++ b/README.md
@@ -1,62 +1 @@
-# api
-joinmisskey servers' information api forked for Sharkey
-
-https://api.joinsharkey.org/instances.json
-
-## Running locally
-
-1. `pnpm i`
-2. `bun index.js` or `node index.js`
-
-## Endpoints
-
-Served statically by [sabo-tabby](https://sabo-tabby.queer.software/)
-
-### /instances.json
-
-```
-{
-    date: Date // The date instances.json was published at.
-    stats: {                      //  statistics
-        notesCount: Number,       //  Total notes
-        usersCount: Number,       //  Total Users
-        mau: Number,              //  Total MAUs
-        instancesCount: Number,   //  Servers counter
-    },
-    instancesInfos: [        // Servers Infos (only alives)
-        {
-            url: String,     //  Hostname e.g. misskey.io
-            name: String,    //  Name e.g. すしすきー
-            langs: String[], //  Language the API author aqz set manually e.g. ["ja"], ["zh"]
-            description: String | Null,  // meta.description
-            isAlive: true,   //  must true
-            banner: Bool,    //  Banner existance
-            background: Bool,//  Background Image existance
-            icon: Bool,      //  Icon Image existance
-            nodeinfo: Object | null,  //  nodeinfo
-            meta: Object | null,      //  result of api/meta
-
-            stats: Object,   //  deprecated (result of api/stats)
-        }, ...
-    ]
-
-}
-```
-
-### /instance-banners/instance.host.{jpeg|webp}
-Banner of each servers (lightweighted)
-
-### /instance-backgrounds/instance.host.{jpeg|webp}
-Background image (displayed behind the welcome page) (lightweighted)
-
-### /instance-icons/instance.host.{png|webp}
-Icon (not favicon) (lightweighted)
-
-### /alives.txt
-List of hosts (separated by `\n`) for servers that were able to communicate
-
-### /deads.txt
-List of hosts (separated by `\n`) for servers that were unable to communicate
-
-### versions.json
-Version list obtained from GitHub
+moved to https://git.joinsharkey.org/Sharkey/jskapi