From 9c42799de3ae35df46162f4d5eef5d8667a7a478 Mon Sep 17 00:00:00 2001 From: Kyren223 Date: Sun, 3 Aug 2025 17:51:55 +0300 Subject: Updated readme --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f4074ab..bfddccd 100644 --- a/README.md +++ b/README.md @@ -34,23 +34,17 @@ Make sure to have a [Nerd Font](https://www.nerdfonts.com/) installed and enable ### Install Latest Version -TODO(kyren): create the install.sh and then host it through eko - ``` curl -sS https://eko.kyren.codes/install.sh | sh ``` -### Winget (Windows) +### Nix Flake -TODO(kyren): package for winget +There is a flake.nix at the root of this repo, you know what to do. -``` -winget install eko -``` +### Build from source -### Nix Flake - -You know what to do +See [Building from source](#building from source). ## Usage @@ -78,7 +72,29 @@ For configuration, self hosting and contributing, read below. ## Configuration -TODO(kyren): add instructions on configuration +### Server-side Settings + +Press `s` to open your user settings, you can change: + +- Your username (pseudonym) +- Your profile description +- Whether non-trusted users can message you + +### Client-side (Local) Settings + +The config is stored in a `eko/config.json` in your system config directory. +This depends on your operating system, press `s` in eko to view the full path. + +Local configuration is saved in eko/config.json within your system's config directory. +This path varies by OS, you can press `s` in eko to see the path. + +Configurable options include (but are not limited to): + +- Customize colors to create your own theme +- Enable or disable telemtry +- Set a default username for login +- Define the number of spaces per tab +- Enable or disable screen borders ### Self-Hosting -- cgit v1.3.1