From b62a22653f19eed2800ff03bee671c5cbf85a2c5 Mon Sep 17 00:00:00 2001
From: ThatOneCalculator <kainoa@t1c.dev>
Date: Mon, 20 Feb 2023 12:20:47 -0800
Subject: [PATCH] update readme

---
 README.md | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index bc4141a8e..fd6b14c25 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ If you have access to a server that supports one of the sources below, I recomme
 
 ### 🐋 Docker
 
-[How to run Calckey with Docker](./docker-README.md).
+[How to run Calckey with Docker](./docs/docker.md).
 
 ## 🧑‍💻 Dependencies
 
@@ -97,9 +97,10 @@ If you have access to a server that supports one of the sources below, I recomme
 ```sh
 git clone --depth 1 https://codeberg.org/calckey/calckey.git
 cd calckey/
-# git checkout main # if you want only stable versions
 ```
 
+By default, you're on the development branch. Run `git checkout beta` or `git checkout main` to switch to the Beta/Main branches.
+
 ## 📩 Install dependencies
 
 ```sh
@@ -123,6 +124,8 @@ psql postgres -c "create database calckey with encoding = 'UTF8';"
 - To add custom CSS for all users, edit `./custom/assets/instance.css`.
 - To add static assets (such as images for the splash screen), place them in the `./custom/assets/` directory. They'll then be available on `https://yourinstance.tld/static-assets/filename.ext`.
 - To add custom locales, place them in the `./custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: `en-FOO.yml`)
+- To add custom error images, place them in the `./custom/assets/badges` directory, replacing the files already there.
+- To add custom sounds, place only mp3 files in the `./custom/assets/sounds` directory.
 - To update custom assets without rebuilding, just run `pnpm run gulp`.
 
 ## 🧑‍🔬 Configuring a new instance
@@ -133,12 +136,7 @@ psql postgres -c "create database calckey with encoding = 'UTF8';"
 
 ## 🚚 Migrating from Misskey to Calckey
 
-> ⚠️ Because of their changes, migrating from Foundkey is not supported.
-
-```sh
-cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/` with misskey path, add `docker.env` if you use Docker
-cp -r ../misskey/files .
-```
+For migrating from Misskey v13, Misskey v12, and Foundkey, read [this document](https://codeberg.org/calckey/calckey/src/branch/develop/docs/migrate.md).
 
 ## 🍀 NGINX