From e5891a52e7c971c4ea3df57905ca06ae968f92c3 Mon Sep 17 00:00:00 2001 From: makeworld Date: Tue, 1 Dec 2020 10:52:06 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Reference=20wiki=20on=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 31 ++++++++----------------------- 1 file changed, 8 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ebdb9f8..944c5ed 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,10 @@ brew upgrade amfora ``` ### From Source + +
+Click to expand + This section is for advanced users who want to install the latest (possibly unstable) version of Amfora. **Requirements:** @@ -89,17 +93,8 @@ You can update it with: brew upgrade --fetch-HEAD amfora ``` -## Usage +
-Just call `amfora` or `amfora ` on the terminal. On Windows it might be `amfora.exe` instead. - -To determine the version, you can run `amfora --version` or `amfora -v`. - -The project keeps many standard terminal keybindings and is intuitive. Press ? inside the application to pull up the help menu with a list of all the keybindings, and Esc to leave it. If you have used Bombadillo you will find it similar. - -It is designed with large terminals in mind, but should look and work well at any reasonable terminal size. - -It was tested with left-to-right languages, and will likely not work as well with right-to-left languages like Arabic. ## Features / Roadmap Features in *italics* are in the master branch, but not in the latest release. @@ -134,22 +129,12 @@ Features in *italics* are in the master branch, but not in the latest release. - [ ] Table of contents for pages - [ ] Search in pages with Ctrl-F - [ ] Support Markdown rendering -- [ ] History browser +- [ ] Persistent history -## Configuration -The config file is written in the intuitive [TOML](https://github.com/toml-lang/toml) file format. See [default-config.toml](./default-config.toml) for details. By default this file is available at `~/.config/amfora/config.toml`, or `$XDG_CONFIG_HOME/amfora/config.toml`, if that variable is set. -On Windows, the file is in `%APPDATA%\amfora\config.toml`, which usually expands to `C:\Users\\AppData\Roaming\amfora\config.toml`. +## Usage & Configuration +Please see [the wiki](https://github.com/makeworld-the-better-one/amfora/wiki) for an introduction on how to use Amfora and configure it. -## Client Certificates - -Amfora has early support for client certs. Eventually Amfora will be able to generate them itself, but for you can do it by using OpenSSL: - -```shell -openssl req -new -subj "/CN=username" -x509 -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -days 1825 -nodes -out cert.pem -keyout key.pem -``` - -This will create a certificate and key file, that can be renamed and moved as you like. See the configuration section above for how to edit your config file to tell Amfora about them. ## Known Bugs