makeworld-the-better-one/amfora
1
1
Fork 0
mirror of https://github.com/makeworld-the-better-one/amfora.git synced 2024-11-25 22:53:02 +03:00
Code Issues Projects Releases Wiki Activity

📝 Reference wiki on readme

Browse Source
This commit is contained in:
makeworld 2020-12-01 10:52:06 -05:00
parent d9637d338e
commit e5891a52e7
1 changed files with 8 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -60,6 +60,10 @@ brew upgrade amfora
```
### From Source
<details>
<summary>Click to expand</summary>
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
</details>
Just call `amfora` or `amfora <url>` 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 <kbd>?</kbd> inside the application to pull up the help menu with a list of all the keybindings, and <kbd>Esc</kbd> 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 <kbd>Ctrl-F</kbd>
- [ ] 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\<username>\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