diff --git a/README.md b/README.md index 89301060d3..7f2d9feb22 100644 --- a/README.md +++ b/README.md @@ -11,39 +11,29 @@ -## โœจ Features +# โœจ About Calckey - - -- **ActivityPub support**\ -Not on Calckey? No problem! Not only can Calckey/Misskey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed! -- **Reactions**\ -You can add emoji reactions to any post! No longer are you bound by a like button, show everyone exactly how you feel with the tap of a button. -- **Drive**\ -With Calckey's built in drive, you get cloud storage right in your social media, where you can upload any files, make folders, and find media from posts you've made! -- **Rich Web UI**\ - Calckey has a rich and easy to use Web UI! - It is highly customizable, from changing the layout and adding widgets to making custom themes. - Furthermore, plugins can be created using AiScript, an original programming language. -- And much more... +- Calckey is based off of Misskey, a powerful microblogging server on ActivityPub with features such as emoji reactions, a customizable web ui, rich chatting, and much more! +- Calckey adds many quality of life changes and bug fixes for users and instance admins alike. +- Read **[this document](./CALCKEY.md)** all for current and future differences. +- Notable differences: + - Recommended Instances timeline + - Improved notifications + - Many more user and admin settings
-## ๐Ÿค” What's different about Calckey? +# ๐Ÿ“ Documentation -Read [this](./CALCKEY.md) for current and future differences. +Misskey/Calckey documentation can be found at [Misskey Hub](https://misskey-hub.net/). -## ๐Ÿ“ Documentation - -Misskey documentation can be found at [Misskey Hub](https://misskey-hub.net/). - -## ๐Ÿšš Migrating from Misskey to Calckey +# ๐Ÿšš Migrating from Misskey to Calckey You need at least ๐Ÿข NodeJS v16.15.0 (v18.4.0 recommended!) and *exactly* ๐Ÿงถ Yarn v3.2.1! -### ๐Ÿ“ฉ Install dependencies +## ๐Ÿ“ฉ Install dependencies ```sh # nvm install 18.4.0 && nvm alias default 18.4.0 && nvm use 18.4.0 @@ -51,7 +41,7 @@ corepack enable yarn set version berry ``` -### ๐Ÿ‘€ Get folder ready +## ๐Ÿ‘€ Get folder ready ```sh git clone https://codeberg.org/thatonecalculator/calckey.git @@ -61,9 +51,9 @@ cp ../misskey/.config/default.yml ./.config/default.yml # or wherever misskey fo # cp -r ../misskey/files . # if you don't use object storage ``` -### ๐Ÿš€ Build and launch! +## ๐Ÿš€ Build and launch! -#### `git pull` and run these steps to update Calckey in the future! +### `git pull` and run these steps to update Calckey in the future! ```sh # git pull @@ -72,6 +62,14 @@ NODE_ENV=production npm run build && npm run migrate # Edit service to point to calckey folder and restart! ``` +### ๐Ÿณ Docker + +```sh +# git pull +sudo docker-compose build +sudo docker-compose stop && sudo docker-compose up -d +``` + # ๐Ÿ’ธ Patrons None yet! You can support of the development of this fork here, every little bit counts: https://liberapay.com/ThatOneCalculator/