README.md at main · fuwn.net/sydney

fuwn.net / sydney

fork atom

🦘 Vim-like, Command-line Gemini Client

gemini gemini-protocol tui smolweb vim

fork atom

sydney / README.md

at main 46 lines 1.1 kB view raw view rendered

wrap content

fuwn.net fix: Update outdated home page URLs 11mo ago

7199431d

 1# Sydney
 2
 3[![crates.io](https://img.shields.io/crates/v/sydney.svg)](https://crates.io/crates/sydney)
 4[![github.com](https://github.com/gemrest/sydney/actions/workflows/rust.yaml/badge.svg?branch=main)](https://github.com/gemrest/sydney/actions/workflows/rust.yaml)
 5
 6Sydney is a Vim-like, command-line Gemini client.
 7
 8[![Video of Sydney in action](https://host.fuwn.me/m3q9cny6pr5f.png)](https://i.imgur.com/l2gw8wp.mp4)
 9
10Sydney has a beautiful, intuitive, and powerful command-line interface;
11including:
12
13- Vim-like keybindings
14- Vim-like commands
15- Intuitive link handling
16- Understandable errors
17- Customizable UI
18
19## Usage
20
21### Installation
22
23```shell
24cargo install sydney --force
25```
26
27### Help
28
29```shell
30usage: syndey [option, capsule_uri]
31Options:
32    --version, -v    show version text
33    --help, -h       show help text
34
35Sample invocations:
36    syndey gemini://fuwn.me/
37    syndey fuwn.me
38    syndey --help
39
40Report bugs to https://github.com/gemrest/sydney/issues
41
42```
43
44## License
45
46This project is licensed with the [GNU General Public License v3.0](https://github.com/gemrest/sydney/blob/main/LICENSE).