Added basic incomplete readme

README.md

@@ -2,9 +2,84 @@
 
 <p>
     <picture>
-      <img width="768" height="192" alt="eko-banner" src="https://github.com/user-attachments/assets/6126da2a-9b46-41c8-9eac-84319ecddb84" />
+      <img width="768" height="192" alt="Eko Banner" src="./assets/eko-banner.png" />
     </picture>
     <br>
-    <a href="https://github.com/charmbracelet/bubbletea/releases"><img src="https://img.shields.io/github/release/charmbracelet/bubbletea.svg" alt="Latest Release"></a>
+    <img alt="GitHub Release" src="https://img.shields.io/github/v/release/kyren223/eko?sort=date&style=for-the-badge&labelColor=%23005d66&color=%23F5A670">
+    <img alt="GitHub License" src="https://img.shields.io/github/license/kyren223/eko?style=for-the-badge&labelColor=%23005d66&color=%23FFBF00">
 </p>
 
+The Discord alternative for Terminal nerds.
+
+<p>
+    <img src="./assets/eko-screenshot.png" width="100%" alt="Eko Showcase">
+</p>
+
+## Features
+
+- 🟢 Vim-style navigation and editing
+- 🔑 SSH-like authentication using public key cryptography
+- 🎨 Customizable colors
+- 🖥️ Smooth and responsive TUI experience
+- 📜 Open protocol for building clients and tools
+- 🏠 Self-hostable or use the official instance
+
+---
+
+## Install
+
+### For Nix
+
+### From releases
+
+### From source
+
+## Usage
+
+Once installed, run `eko` in a terminal.
+
+Use `tab` / `shift+tab` to cycle, `ctrl+s` to switch between sign-in and sign-up
+and `enter` to confirm.
+
+Use an existing SSH ed25519 key (e.g `~/.ssh/id_ed25519`) or specify a new
+path to generate one.
+
+By default, you will connect to the official instance.
+For self hosting, see [Self Hosting](#self-hosting).
+
+Press `?` to see available keybindings.
+They are inspired by vim and should feel intuitive.
+
+To ask questions, suggest features, or chat with the community,
+it's recommended to join the official server. To do so press `a` while focused
+on the network list and paste `<invite code>` into it.
+
+And that's it!
+
+For configuration, self hosting and contributing, read below.
+
+## Configuration
+
+### Self-Hosting
+
+## Contributing
+
+See [contributing][contribute].
+
+[contribute]: https://github.com/kyren223/eko/blob/master/CONTRIBUTING.md
+
+## Feedback
+
+I’d love to hear your thoughts on this project.
+Reach me via:
+
+- Eko: `<My ID>` (focus the Signal pane, press `a` and paste)
+- Discord: Kyren223
+
+## Licenses
+
+Copyright (C) 2025 Kyren223
+
+All source code is licensed under [AGPLv3](https://github.com/kyren223/eko/raw/main/LICENSE).
+All content in the `assets` directory is licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+Logos and artwork are copyrighted works of Kyren223.

assets/demo.tape

@@ -0,0 +1,69 @@
+# VHS documentation
+#
+# Output:
+#   Output <path>.gif               Create a GIF output at the given <path>
+#   Output <path>.mp4               Create an MP4 output at the given <path>
+#   Output <path>.webm              Create a WebM output at the given <path>
+#
+# Require:
+#   Require <string>                Ensure a program is on the $PATH to proceed
+#
+# Settings:
+#   Set FontSize <number>           Set the font size of the terminal
+#   Set FontFamily <string>         Set the font family of the terminal
+#   Set Height <number>             Set the height of the terminal
+#   Set Width <number>              Set the width of the terminal
+#   Set LetterSpacing <float>       Set the font letter spacing (tracking)
+#   Set LineHeight <float>          Set the font line height
+#   Set LoopOffset <float>%         Set the starting frame offset for the GIF loop
+#   Set Theme <json|string>         Set the theme of the terminal
+#   Set Padding <number>            Set the padding of the terminal
+#   Set Framerate <number>          Set the framerate of the recording
+#   Set PlaybackSpeed <float>       Set the playback speed of the recording
+#   Set MarginFill <file|#000000>   Set the file or color the margin will be filled with.
+#   Set Margin <number>             Set the size of the margin. Has no effect if MarginFill isn't set.
+#   Set BorderRadius <number>       Set terminal border radius, in pixels.
+#   Set WindowBar <string>          Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
+#   Set WindowBarSize <number>      Set window bar size, in pixels. Default is 40.
+#   Set TypingSpeed <time>          Set the typing speed of the terminal. Default is 50ms.
+#
+# Sleep:
+#   Sleep <time>                    Sleep for a set amount of <time> in seconds
+#
+# Type:
+#   Type[@<time>] "<characters>"    Type <characters> into the terminal with a
+#                                   <time> delay between each character
+#
+# Keys:
+#   Escape[@<time>] [number]        Press the Escape key
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Delete[@<time>] [number]        Press the Delete key
+#   Insert[@<time>] [number]        Press the Insert key
+#   Down[@<time>] [number]          Press the Down key
+#   Enter[@<time>] [number]         Press the Enter key
+#   Space[@<time>] [number]         Press the Space key
+#   Tab[@<time>] [number]           Press the Tab key
+#   Left[@<time>] [number]          Press the Left Arrow key
+#   Right[@<time>] [number]         Press the Right Arrow key
+#   Up[@<time>] [number]            Press the Up Arrow key
+#   Down[@<time>] [number]          Press the Down Arrow key
+#   PageUp[@<time>] [number]        Press the Page Up key
+#   PageDown[@<time>] [number]      Press the Page Down key
+#   Ctrl+<key>                      Press the Control key + <key> (e.g. Ctrl+C)
+#
+# Display:
+#   Hide                            Hide the subsequent commands from the output
+#   Show                            Show the subsequent commands in the output
+
+Output assets/demo.gif
+
+Require echo
+
+Set Shell "bash"
+Set FontSize 32
+Set Width 1200
+Set Height 600
+
+Type "echo 'Welcome to VHS!'" Sleep 500ms  Enter
+
+Sleep 5s