mirror of
https://github.com/Kyren223/eko.git
synced 2026-07-17 17:11:03 +00:00
Updated readme
This commit is contained in:
24
README.md
24
README.md
@@ -11,6 +11,8 @@
|
||||
|
||||
The Discord alternative for Terminal nerds.
|
||||
|
||||
TODO(kyren): replace screenshot with tape (or have both?)
|
||||
|
||||
<p>
|
||||
<img src="./assets/eko-screenshot.png" width="100%" alt="Eko Showcase">
|
||||
</p>
|
||||
@@ -73,8 +75,8 @@ 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.
|
||||
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!
|
||||
|
||||
@@ -82,6 +84,16 @@ For configuration, self hosting and contributing, read below.
|
||||
|
||||
## Configuration
|
||||
|
||||
TODO(kyren): add instructions on configuration
|
||||
|
||||
### Self-Hosting
|
||||
|
||||
TODO(kyren): add instructions on self-hosting
|
||||
|
||||
## Contributing
|
||||
|
||||
See [contributing][https://github.com/kyren223/eko/blob/master/CONTRIBUTING.md].
|
||||
|
||||
### Building from source
|
||||
|
||||
Clone the repository
|
||||
@@ -98,14 +110,6 @@ 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
|
||||
|
||||
See [contributing][contribute].
|
||||
|
||||
[contribute]: https://github.com/kyren223/eko/blob/master/CONTRIBUTING.md
|
||||
|
||||
## Feedback
|
||||
|
||||
I’d love to hear your thoughts on this project.
|
||||
|
||||
Reference in New Issue
Block a user