feat: initial release

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a20618
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Sydney
+
+[![crates.io](https://img.shields.io/crates/v/sydney.svg)](https://crates.io/crates/sydney)
+[![github.com](https://github.com/gemrest/sydney/actions/workflows/rust.yaml/badge.svg?branch=main)](https://github.com/gemrest/sydney/actions/workflows/rust.yaml)
+
+Sydney is a Vim-like, command-line Gemini client.
+
+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).