summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyren223 <kyren223@proton.me>2025-08-02 19:44:05 +0300
committerKyren223 <kyren223@proton.me>2025-08-02 19:44:05 +0300
commit779144ad7705556c56ee06f983a43b1e7af8bc30 (patch)
treef48b50f4c2575f751cc069c64668a7ea1c567278 /README.md
parent262d735986fed9337a91ba814596fed121fed3e3 (diff)
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 33 insertions, 9 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