Skip to content

Commit 6ec2436

Browse files
authored
Documentation: clarify wording in readme
1 parent 56520cf commit 6ec2436

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

Readme.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ KeePassTrayIconLockState
33

44
[![Build status](https://img.shields.io/github/actions/workflow/status/Aldaviva/KeePassTrayIconLockState/dotnetframework.yml?branch=master&logo=github)](https://github.com/Aldaviva/KeePassTrayIconLockState/actions/workflows/dotnetframework.yml) [![Test status](https://img.shields.io/testspace/tests/Aldaviva/Aldaviva:KeePassTrayIconLockState/master?passed_label=passing&failed_label=failing&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4NTkgODYxIj48cGF0aCBkPSJtNTk4IDUxMy05NCA5NCAyOCAyNyA5NC05NC0yOC0yN3pNMzA2IDIyNmwtOTQgOTQgMjggMjggOTQtOTQtMjgtMjh6bS00NiAyODctMjcgMjcgOTQgOTQgMjctMjctOTQtOTR6bTI5My0yODctMjcgMjggOTQgOTQgMjctMjgtOTQtOTR6TTQzMiA4NjFjNDEuMzMgMCA3Ni44My0xNC42NyAxMDYuNS00NFM1ODMgNzUyIDU4MyA3MTBjMC00MS4zMy0xNC44My03Ni44My00NC41LTEwNi41UzQ3My4zMyA1NTkgNDMyIDU1OWMtNDIgMC03Ny42NyAxNC44My0xMDcgNDQuNXMtNDQgNjUuMTctNDQgMTA2LjVjMCA0MiAxNC42NyA3Ny42NyA0NCAxMDdzNjUgNDQgMTA3IDQ0em0wLTU1OWM0MS4zMyAwIDc2LjgzLTE0LjgzIDEwNi41LTQ0LjVTNTgzIDE5Mi4zMyA1ODMgMTUxYzAtNDItMTQuODMtNzcuNjctNDQuNS0xMDdTNDczLjMzIDAgNDMyIDBjLTQyIDAtNzcuNjcgMTQuNjctMTA3IDQ0cy00NCA2NS00NCAxMDdjMCA0MS4zMyAxNC42NyA3Ni44MyA0NCAxMDYuNVMzOTAgMzAyIDQzMiAzMDJ6bTI3NiAyODJjNDIgMCA3Ny42Ny0xNC44MyAxMDctNDQuNXM0NC02NS4xNyA0NC0xMDYuNWMwLTQyLTE0LjY3LTc3LjY3LTQ0LTEwN3MtNjUtNDQtMTA3LTQ0Yy00MS4zMyAwLTc2LjY3IDE0LjY3LTEwNiA0NHMtNDQgNjUtNDQgMTA3YzAgNDEuMzMgMTQuNjcgNzYuODMgNDQgMTA2LjVTNjY2LjY3IDU4NCA3MDggNTg0em0tNTU3IDBjNDIgMCA3Ny42Ny0xNC44MyAxMDctNDQuNXM0NC02NS4xNyA0NC0xMDYuNWMwLTQyLTE0LjY3LTc3LjY3LTQ0LTEwN3MtNjUtNDQtMTA3LTQ0Yy00MS4zMyAwLTc2LjgzIDE0LjY3LTEwNi41IDQ0UzAgMzkxIDAgNDMzYzAgNDEuMzMgMTQuODMgNzYuODMgNDQuNSAxMDYuNVMxMDkuNjcgNTg0IDE1MSA1ODR6IiBmaWxsPSIjZmZmIi8%2BPC9zdmc%2B)](https://aldaviva.testspace.com/spaces/234282) [![Coverage status](https://img.shields.io/coveralls/github/Aldaviva/KeePassTrayIconLockState?logo=coveralls)](https://coveralls.io/github/Aldaviva/KeePassTrayIconLockState?branch=master)
55

6-
Replace the default KeePass Windows ME–style tray icon with a wireframe padlock icon to match the style of built-in tray icons in Windows 10 and 11.
6+
Replace the default KeePass Windows 98–style tray icon with a wireframe padlock icon to match the style of built-in tray icons in Windows 10 and 11.
77

88
- While the database is being opened, an hourglass icon is shown on top of the padlock, so you can tell when it's done opening and ready to use.
99
- When the database is locked or closed, the icon will be hidden, because it's distracting and not useful in this state that is effectively identical to exiting KeePass.
@@ -16,12 +16,14 @@ Replace the default KeePass Windows ME–style tray icon with a wireframe padloc
1616

1717
## Installation
1818
1. Download [**`KeePassTrayIconLockState.dll`**](https://github.com/Aldaviva/KeePassTrayIconLockState/releases/latest/download/KeePassTrayIconLockState.dll) from the [latest release](https://github.com/Aldaviva/KeePassTrayIconLockState/releases/latest).
19-
1. Save `KeePassTrayIconLockState.dll` to the `Plugins` directory inside your KeePass installation directory, or a subfolder, *e.g.*
19+
1. Save `KeePassTrayIconLockState.dll` to the `Plugins` directory inside your KeePass installation directory, or a subfolder, such as
2020
```text
21-
C:\Program Files\KeePass Password Safe 2\Plugins\KeePassTrayIconLockState\KeePassTrayIconLockState.dll
21+
C:\Program Files\KeePass Password Safe 2\Plugins\KeePassTrayIconLockState.dll
2222
```
2323
1. Restart KeePass.
2424
25+
These same instructions also apply to upgrades of existing plugin installations.
26+
2527
## Behavior
2628
<dl>
2729
<dt><img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocked.ico" height="16" /> Database is open</dt>
@@ -33,22 +35,24 @@ Replace the default KeePass Windows ME–style tray icon with a wireframe padloc
3335
</dl>
3436
3537
## Configuration
38+
There is no required configuration for this plugin. Optional settings are described below.
39+
3640
### Custom icons
37-
To change the icons that this plugin renders from the default ones, you can create your own icon files in same directory as this plugin's `KeePassTrayIconLockState.dll` file.
41+
To optionally override the [Windows 10/11 style wireframe icons](#behavior) that this plugin renders, you can create your own custom icon files in same directory as this plugin's `KeePassTrayIconLockState.dll` file. This is useful if you don't like the wireframe icons from this plugin, but you also don't want to fork or reimplement this entire plugin and all its logic just to change a few image resources.
3842
39-
The icons can each contain a 16×16px image for normal DPI (100%) screens and a 32×32px image for high DPI (≈200%) screens. If your scaling factor is not represented, such as 150%, you can supply other dimensions as well, otherwise, Windows will scale down the larger image so that it doesn't look blurry.
43+
Each of the icon files can contain a 16×16px image for normal DPI (100%) screens as well as a 32×32px image for high DPI (≈200%) screens. If your scaling factor is not represented, such as 150%, you can supply other dimensions as well in the same file, such as 24×24px, otherwise, Windows will scale down the larger image so that it doesn't look blurry.
4044
41-
You can use any icon editing program you want to edit or convert images to ICO files, such as [Iconaton](https://sourceforge.net/projects/iconaton/files/iconaton/Iconaton%200.1%20Beta%201/).
45+
You can use any icon editing program you want to edit or convert images to ICO files, such as [Iconaton](https://sourceforge.net/projects/iconaton/files/iconaton/Iconaton%200.1%20Beta%201/). 32-bit color (8bpc with transparency) is supported.
4246
4347
Icon files with the following filenames will be used by this plugin.
4448
45-
|filename|database state|OS theme|default plugin icon|
49+
|icon filename|database state|OS theme|default plugin icon to replace|
4650
|---|---|---|---|
47-
|`opening-lighttaskbar.ico`|loading|light|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocking-light.ico" height="16" /> black padlock and hourglass|
48-
|`opening-darktaskbar.ico`|loading|dark|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocking.ico" height="16" /> white padlock and hourglass|
49-
|`open-lighttaskbar.ico`|loaded|light|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocked-light.ico" height="16" /> black padlock|
50-
|`open-darktaskbar.ico`|loaded|dark|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocked.ico" height="16" /> white padlock|
51+
|`opening-lighttaskbar.ico`|opening|light|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocking-light.ico" height="16" /> black padlock and hourglass|
52+
|`opening-darktaskbar.ico`|opening|dark|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocking.ico" height="16" /> white padlock and hourglass|
53+
|`open-lighttaskbar.ico`|open|light|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocked-light.ico" height="16" /> black padlock|
54+
|`open-darktaskbar.ico`|open|dark|<img src="https://raw.githubusercontent.com/Aldaviva/KeePassTrayIconLockState/master/KeePassTrayIconLockState/Resources/unlocked.ico" height="16" /> white padlock|
5155
52-
Any states for which you don't supply an icon file will be rendered with this plugin's built-in icons, so you don't have to provide all four files if you don't want to.
56+
Any states for which you don't supply an icon file will be rendered with this plugin's built-in wireframe icons, so you don't have to provide all four files if you don't want to.
5357
54-
Changes to these icon files take effect after restarting KeePass.
58+
Changes to these icon files take effect after restarting KeePass.

0 commit comments

Comments
 (0)