From 779144ad7705556c56ee06f983a43b1e7af8bc30 Mon Sep 17 00:00:00 2001 From: Kyren223 Date: Sat, 2 Aug 2025 19:44:05 +0300 Subject: Updated readme --- README.md | 42 +++++++++++++++++++++++++++++++++--------- internal/server/server.go | 2 +- 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1173e40..8f70b96 100644 --- a/README.md +++ b/README.md @@ -26,27 +26,35 @@ The Discord alternative for Terminal nerds. --- -## Install +## Quick Install -### For Nix +Make sure to have a [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. -### From releases +### Install Latest Version -### From source +``` +curl -sS https://eko.kyren.codes/install.sh | sh +``` -Clone the repository +### Homebrew (MACOS) + +TODO(kyren): package for homebrew ``` -git clone https://github.com/kyren223/eko +brew install eko ``` -Build the executable (make sure you have `go` installed) +### Winget (Windows) + +TODO(kyren): package for winget ``` -cd eko && go build -o ./eko ./cmd/client +winget install eko ``` -Move the executable to somewhere in your path so you can access it from anywhere +### Nix Flake + +You know what to do ## Usage @@ -74,6 +82,22 @@ For configuration, self hosting and contributing, read below. ## Configuration +### Building from source + +Clone the repository + +``` +git clone https://github.com/kyren223/eko +``` + +Build the executable (make sure you have `go` installed) + +``` +cd eko && go build -o ./eko ./cmd/client +``` + +Move the executable to somewhere in your path so you can access it from anywhere + ### Self-Hosting ## Contributing diff --git a/internal/server/server.go b/internal/server/server.go index 1a538de..498b223 100644 --- a/internal/server/server.go +++ b/internal/server/server.go @@ -555,7 +555,7 @@ func timeout[T packet.Payload]( apiRequest func(context.Context, *session.Session, T) packet.Payload, ctx context.Context, sess *session.Session, request T, ) packet.Payload { - // TODO: Remove the channel and just wait directly? + // TODO(kyren): Remove the channel and just wait directly? // No - We need to use a channel so timeout works properly responseChan := make(chan packet.Payload) -- cgit v1.3.1