📖 Document added option in README and CHANGELOG

Added simple documentation for option in the project's markdown README
file, and add a quick line in changelog additions.
This commit is contained in:
Marty Oehme 2022-09-27 18:28:43 +02:00
parent 94110cda3e
commit 3745307fd7
Signed by: Marty
GPG Key ID: 73BA40D5AFAF49C9
2 changed files with 21 additions and 2 deletions

View File

@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
<!-- ### Added -->
### Added
- Add new option `-n` which suppresses printing the final newline character in output
### Changed

View File

@ -170,7 +170,7 @@ To display *only* the emoji list passed in, pass an extra `-P` flag to bemoji.
The path can also be a weblink which bemoji will download and use:
```
```bash
bemoji -f "https://raw.githubusercontent.com/jchook/emoji-menu/master/data/emojis.txt"
```
@ -190,6 +190,22 @@ Other valid options for this setting are `emoji`, `math`, `none`.
If set to `none` and no files are in the emoji directory,
bemoji will simply complain and not show anything.
### Do not skip to new line after output
By default, bemoji will craft the final output using a typical `echo` call for anything it prints directly.
That means, it will also contain a final newline character.
So, for example it would technically output `🦊\n` for the `fox` emoji,
which skips to a new line in most circumstances.
If you wish to prevent this character in the final output, use:
```bash
bemoji -n
```
Using this option will suppress the newline character and *only* print `🦊` as its output.
### Using a custom tool for picking, clipping, typing
If you want to replace one of the default supported tools with your own you can do this through environment variables:
@ -234,6 +250,7 @@ BEMOJI_CLIP_CMD=wl-copy # which clipboard tool to use
BEMOJI_TYPE_CMD=wtype # which typing tool to use (ydotool will NOT work)
BEMOJI_PRIVATE_MODE=false # whether to save new entries
BEMOJI_IGNORE_RECENT=false # whether to display recent entries
BEMOJI_ECHO_NEWLINE=true # whether to end the output with a newline character
```
## 🤗 Issues