summaryrefslogtreecommitdiff
path: root/projects/sydney.gmi
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-07-17 04:20:16 -0700
committerFuwn <[email protected]>2022-07-17 04:20:16 -0700
commit6c6f9b27887422548ecb72735f78af9c08d21175 (patch)
tree2c24024492f82034e5c5bfd5fd7db8e152ec1b41 /projects/sydney.gmi
parentrefactor: absolute path (diff)
downloadgem.rest-6c6f9b27887422548ecb72735f78af9c08d21175.tar.xz
gem.rest-6c6f9b27887422548ecb72735f78af9c08d21175.zip
feat(projects): add sydney
Diffstat (limited to 'projects/sydney.gmi')
-rw-r--r--projects/sydney.gmi55
1 files changed, 55 insertions, 0 deletions
diff --git a/projects/sydney.gmi b/projects/sydney.gmi
new file mode 100644
index 0000000..71cbff1
--- /dev/null
+++ b/projects/sydney.gmi
@@ -0,0 +1,55 @@
+```
+ _____ _
+/ ___| | |
+\ `--. _ _ __| |_ __ ___ _ _
+ `--. \ | | |/ _` | '_ \ / _ \ | | |
+/\__/ / |_| | (_| | | | | __/ |_| |
+\____/ \__, |\__,_|_| |_|\___|\__, |
+ __/ | __/ |
+ |___/ |___/
+```
+
+=> https://crates.io/crates/sydney crates.io
+=> https://github.com/gemrest/sydney/actions/workflows/rust.yaml/badge.svg?branch=main GitHub
+
+Sydney is a Vim-like, command-line Gemini client.
+
+=> https://host.fuwn.me/c2uvq9mqiccc.gif Gif of Sydney in action
+
+Sydney has a beautiful, intuitive, and powerful command-line interface; including:
+
+* Vim-like keybindings
+* Vim-like commands
+* Intuitive link handling
+* Understandable errors
+* Customizable UI
+
+## Usage
+
+### Installation
+
+```shell
+cargo install sydney --force
+```
+
+### Help
+
+```shell
+usage: syndey [option, capsule_uri]
+Options:
+ --version, -v show version text
+ --help, -h show help text
+
+Sample invocations:
+ syndey gemini://gem.rest/
+ syndey --help
+
+Report bugs to https://github.com/gemrest/sydney/issues
+
+```
+
+## License
+
+This project is licensed with the GNU General Public License v3.0.
+
+=> https://github.com/gemrest/sydney/blob/main/LICENSE GNU General Public License v3.0