diff --git a/README.md b/README.md index bdc95de..372974c 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,84 @@

- eko-banner + Eko Banner
- Latest Release + GitHub Release + GitHub License

+The Discord alternative for Terminal nerds. + +

+ Eko Showcase +

+ +## 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 `` 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: `` (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. diff --git a/assets/demo.tape b/assets/demo.tape new file mode 100644 index 0000000..b7f201b --- /dev/null +++ b/assets/demo.tape @@ -0,0 +1,69 @@ +# VHS documentation +# +# Output: +# Output .gif Create a GIF output at the given +# Output .mp4 Create an MP4 output at the given +# Output .webm Create a WebM output at the given +# +# Require: +# Require Ensure a program is on the $PATH to proceed +# +# Settings: +# Set FontSize Set the font size of the terminal +# Set FontFamily Set the font family of the terminal +# Set Height Set the height of the terminal +# Set Width Set the width of the terminal +# Set LetterSpacing Set the font letter spacing (tracking) +# Set LineHeight Set the font line height +# Set LoopOffset % Set the starting frame offset for the GIF loop +# Set Theme Set the theme of the terminal +# Set Padding Set the padding of the terminal +# Set Framerate Set the framerate of the recording +# Set PlaybackSpeed Set the playback speed of the recording +# Set MarginFill Set the file or color the margin will be filled with. +# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set. +# Set BorderRadius Set terminal border radius, in pixels. +# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight) +# Set WindowBarSize Set window bar size, in pixels. Default is 40. +# Set TypingSpeed